Add a tox environment to build the docs
Change-Id: Ie28fa116759b1992a46455cb49842f69dc74aeb5
This commit is contained in:
parent
d4a45528bb
commit
f6f0ec5759
|
@ -15,6 +15,9 @@
|
||||||
import sys
|
import sys
|
||||||
import os
|
import os
|
||||||
|
|
||||||
|
# Always use the default theme for Readthedocs
|
||||||
|
RTD_NEW_THEME = True
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
|
@ -109,7 +112,7 @@ pygments_style = 'sphinx'
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
html_theme = 'default'
|
html_theme = 'classic'
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a 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
|
# further. For a list of options available for each theme, see the
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
Sphinx
|
9
tox.ini
9
tox.ini
|
@ -1,5 +1,5 @@
|
||||||
[tox]
|
[tox]
|
||||||
envlist = heka,lma_collector
|
envlist = heka,lma_collector,docs
|
||||||
skipsdist = True
|
skipsdist = True
|
||||||
|
|
||||||
[testenv:heka]
|
[testenv:heka]
|
||||||
|
@ -17,3 +17,10 @@ whitelist_externals = bundle
|
||||||
commands =
|
commands =
|
||||||
bundle install
|
bundle install
|
||||||
bundle exec rake test
|
bundle exec rake test
|
||||||
|
|
||||||
|
[testenv:docs]
|
||||||
|
deps = -r{toxinidir}/test-requirements.txt
|
||||||
|
changedir = {toxinidir}/doc
|
||||||
|
whitelist_externals = make
|
||||||
|
commands =
|
||||||
|
make clean html SPHINXOPTS=-W
|
||||||
|
|
Loading…
Reference in New Issue