From d5a7fa17245747c0be94cd3fa1859e6093e05a21 Mon Sep 17 00:00:00 2001 From: Thomas Schraitle Date: Sun, 24 Mar 2019 17:37:23 +0100 Subject: [PATCH] Fix #126: Provide tox.ini for documentation * Add "docs" target to run sphinx and output HTML * Provide docs/requirements.txt file * Fix typo in docs/conf.py --- docs/conf.py | 2 +- docs/requirements.txt | 3 +++ tox.ini | 6 ++++++ 3 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 843b7466..1afd8e7f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -172,6 +172,6 @@ ] -interpshinx_mapping = { +intersphinx_mapping = { "matplotlib": ('http://matplotlib.org', None), } diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..383acaaa --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +# requirements file for documentation +sphinx +sphinx_rtd_theme diff --git a/tox.ini b/tox.ini index 82695362..5ed45e4f 100644 --- a/tox.ini +++ b/tox.ini @@ -16,3 +16,9 @@ setenv = basepython = python3 deps = flake8 commands = flake8 + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/docs/requirements.txt +skip_install = true +commands = sphinx-build {posargs:-E} -b html docs dist/docs