openstack
/
specs-cookiecutter
Code Issues Proposed changes

make tox docs environment follow PTI guidelines for sphinx build 

https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation
says:

    Note:

    We strongly discourage project teams from adding commands to the
    docs environment beyond:

        sphinx-build -W -b html doc/source doc/build/html

Discussion on #openstack-doc prompted the suggestion to adjust the
cookiecutter templates accordingly:

http://eavesdrop.openstack.org/irclogs/%23openstack-doc/%23openstack-doc.2018-08-09.log.html#t2018-08-09T16:04:54

Also update requirements.txt.

Change-Id: Ib3733daffb724fa13267aec6ac4f14cb91bcd5ba
This commit is contained in:
Adam Spiers 2018-08-09 18:07:10 +01:00
parent 5be6883fc1
commit fe1271a182
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
{{cookiecutter.repo_name}}/requirements.txt
View File

@ -1,4 +1,4 @@
pbr>=0.11,<2.0
pbr>=2.0.0
oslosphinx
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
yasfb>=0.5.1

2
{{cookiecutter.repo_name}}/tox.ini
View File

@ -15,7 +15,7 @@ deps = -r{toxinidir}/requirements.txt
commands = {posargs}
[testenv:docs]
commands = python setup.py build_sphinx
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:spelling]
deps =