diff options
| author | John Anderson <sontek@gmail.com> | 2015-02-09 13:50:29 -0800 |
|---|---|---|
| committer | John Anderson <sontek@gmail.com> | 2015-02-09 13:50:29 -0800 |
| commit | c88e3cedf44c257a9dc4c00017114fca3f4e58c0 (patch) | |
| tree | 89f1022c8a3421bec2f1be063b5a637d26cb95ab | |
| parent | 3ab9a42fcf43466f233068585f47154fbd34760b (diff) | |
| download | kafka-python-c88e3cedf44c257a9dc4c00017114fca3f4e58c0.tar.gz | |
Allow better usage of docs locally.
This will default to the rtd theme and introduces
tox -e docs for generating docs locally.
| -rw-r--r-- | docs/conf.py | 7 | ||||
| -rw-r--r-- | docs/index.rst | 3 | ||||
| -rw-r--r-- | tox.ini | 12 |
3 files changed, 18 insertions, 4 deletions
diff --git a/docs/conf.py b/docs/conf.py index 9e95f79..25b3d4d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -262,3 +262,10 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] diff --git a/docs/index.rst b/docs/index.rst index 79167b0..cdcddbc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,3 @@ - kafka-python ============ @@ -51,11 +50,9 @@ Contents usage api_reference - Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` - @@ -1,5 +1,6 @@ [tox] -envlist = lint, py26, py27, pypy, py33, py34 +envlist = lint, py26, py27, pypy, py33, py34, docs + [testenv] deps = six @@ -37,3 +38,12 @@ deps = mock pylint commands = pylint {posargs: -E kafka test} + +[testenv:docs] +deps = + sphinxcontrib-napoleon + sphinx_rtd_theme + sphinx + +commands = + sphinx-build -b html docs/ docs/_build |