aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Ganssle <paul@ganssle.io>2018-04-24 19:29:46 -0400
committerPaul Ganssle <paul@ganssle.io>2018-04-24 19:29:46 -0400
commit5e13f6dd0b17799c4e730fab1272697779462f7f (patch)
tree2cdc0cf5b6942894487085e8c029875c7e5319da
parent187b69dd5659e26f1b0098cb1c126c4b663e0d4d (diff)
downloaddateutil-5e13f6dd0b17799c4e730fab1272697779462f7f.tar.gz
Change the default docs theme and build
-rw-r--r--changelog.d/707.doc.rst1
-rw-r--r--docs/conf.py2
-rw-r--r--docs/requirements-docs.txt2
-rw-r--r--tox.ini2
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
diff --git a/tox.ini b/tox.ini
index 53c317b..912b91b 100644
--- a/tox.ini
+++ b/tox.ini
@@ -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}