diff options
author | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-02-05 11:20:11 +0100 |
---|---|---|
committer | Cédric Ollivier <cedric.ollivier@orange.com> | 2018-02-05 17:15:33 +0100 |
commit | 7b8e07e9100974a506c7dd31c8bf190ecf69840c (patch) | |
tree | 7f010eb2eec7841fe2a069369dc3dd3bad12a2ab | |
parent | 8f23ca12081c369423eab9456f8629b9c9680602 (diff) |
Switch to the readthedocs theme for api docs
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>
-rw-r--r-- | api/conf.py | 2 | ||||
-rw-r--r-- | api/requirements.txt | 3 | ||||
-rw-r--r-- | test-requirements.txt | 1 |
3 files changed, 5 insertions, 1 deletions
diff --git a/api/conf.py b/api/conf.py index 746a90fe0..b5adb4ca3 100644 --- a/api/conf.py +++ b/api/conf.py @@ -121,7 +121,7 @@ todo_include_todos = False # 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 diff --git a/api/requirements.txt b/api/requirements.txt new file mode 100644 index 000000000..0d38313b8 --- /dev/null +++ b/api/requirements.txt @@ -0,0 +1,3 @@ +git+https://gerrit.opnfv.org/gerrit/snaps#egg=snaps +sphinx>=1.6.2 # BSD +sphinx-rtd-theme diff --git a/test-requirements.txt b/test-requirements.txt index 569b80c3d..422cbeb6b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -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 |