diff options
-rw-r--r-- | changelog.d/707.doc.rst | 1 | ||||
-rw-r--r-- | docs/conf.py | 2 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 2 | ||||
-rw-r--r-- | tox.ini | 2 |
4 files changed, 5 insertions, 2 deletions
diff --git a/changelog.d/707.doc.rst b/changelog.d/707.doc.rst new file mode 100644 index 0000000..dc65d5b --- /dev/null +++ b/changelog.d/707.doc.rst @@ -0,0 +1 @@ +Changed the default theme to sphinx_rtd_theme, and changed the sphinx configuration to go along with that. (gh pr #707) diff --git a/docs/conf.py b/docs/conf.py index c970177..da18a25 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -106,7 +106,7 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +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/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..7c70149 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,2 @@ +Sphinx>=1.7.3,<2 +sphinx_rtd_theme>=0.3.0 @@ -53,7 +53,7 @@ show_missing = True [testenv:docs] description = invoke sphinx-build to build the HTML docs, check that URIs are valid basepython = python3.6 -deps = sphinx >= 1.6.3, < 2 +deps = -r docs/requirements-docs.txt {[testenv]deps} commands = sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -bhtml} sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out" {posargs:-W --color -blinkcheck} |