Skip to content

Commit

Permalink
Switch to the readthedocs theme for api docs
Browse files Browse the repository at this point in the history
It also adds a requirement file for external doc tools wich couldn't
handle upper constraints.

Change-Id: Idf8f43e5e1a845055ce248f1dc8b8d676a3ac37b
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
  • Loading branch information
collivier committed Feb 5, 2018
1 parent 8f23ca1 commit 7b8e07e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion api/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
3 changes: 3 additions & 0 deletions api/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
git+https://gerrit.opnfv.org/gerrit/snaps#egg=snaps
sphinx>=1.6.2 # BSD
sphinx-rtd-theme
1 change: 1 addition & 0 deletions test-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ nose # LGPL
flake8<2.6.0,>=2.5.4 # MIT
pylint==1.4.5 # GPLv2
sphinx>=1.6.2 # BSD
sphinx-rtd-theme
yamllint

0 comments on commit 7b8e07e

Please sign in to comment.