Allow better usage of docs locally.
This will default to the rtd theme and introduces tox -e docs for generating docs locally.
This commit is contained in:
@@ -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()]
|
||||
|
@@ -1,4 +1,3 @@
|
||||
|
||||
kafka-python
|
||||
============
|
||||
|
||||
@@ -51,11 +50,9 @@ Contents
|
||||
usage
|
||||
api_reference
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
12
tox.ini
12
tox.ini
@@ -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
|
||||
|
Reference in New Issue
Block a user