Skip to content

Commit 1523452

Browse files
committed
Add a 'docs-doc2dash' Tox target.
Generates a Dash-style docset from the Sphinx-rendered HTML.
1 parent b98aad3 commit 1523452

File tree

4 files changed

+14
-0
lines changed

4 files changed

+14
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ pip-log.txt
4444

4545
# Built documentation
4646
docs/_build
47+
docs/_build_doc2dash
4748

4849
# Virtual environment
4950
env/
1.93 KB
Loading

docs/_static/images/gcp-logo.png

2.28 KB
Loading

tox.ini

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,19 @@ deps =
7979
sphinx_rtd_theme
8080
passenv = {[testenv:system-tests]passenv} SPHINX_RELEASE READTHEDOCS
8181

82+
[testenv:docs-doc2dash]
83+
setenv =
84+
PYTHONPATH = {toxinidir}/_testing
85+
basepython = {[testenv:docs]basepython}
86+
commands =
87+
sphinx-build -W -b html -d docs/_build_doc2dash/doctrees docs docs/_build_doc2dash/html
88+
doc2dash -vv --force -n gcloud-python -i docs/_static/images/gcp-logo-32x32.png -I index.html -u https://gcloud-python.rtfd.org/ -d docs/_build_doc2dash/ docs/_build_doc2dash/html
89+
deps =
90+
{[testenv:docs]deps}
91+
doc2dash
92+
passenv =
93+
{[testenv:docs]passenv}
94+
8295
[pep8]
8396
exclude =
8497
docs/conf.py,

0 commit comments

Comments
 (0)