summaryrefslogtreecommitdiff
path: root/doc/requirements.txt
AgeCommit message (Collapse)AuthorFilesLines
2019-10-14tox: Keeping going with docsjacky061-2/+3
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name suggests, keeps the build running when it encounters non-fatal errors. This is exceptionally useful in avoiding a continuous edit-build loop when undertaking large doc reworks where multiple errors may be introduced. [1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045 Change-Id: I6b8897472220e2f45ec3230be8d3f82adacc7c7e
2019-09-17Build pdf docMark Goddard1-0/+1
The is one of community goals that each project should produce a single PDF file. The pdf should be in the output of openstack-tox-docs job. TeX packages are required to build PDF locally, following is recommended: * inkscape * texlive-latex-base * texlive-latex-extra * texlive-fonts-recommended More about the goal: https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html https://etherpad.openstack.org/p/train-pdf-support-goal https://etherpad.openstack.org/p/pdf-goal-train-common-problems Change-Id: Ia0f8b73bcbda6295319f5c8de1aa02a40844207b
2019-07-03Blacklist sphinx 2.1.0 (autodoc bug)ljhuang1-1/+1
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details Depend-On: https://review.opendev.org/#/c/663060/ Change-Id: I346c06631ea4ed57ecec94aa31b787c649085346
2019-06-14doc: Start using openstackdoctheme's extlink extensionchenxing1-1/+1
This ensures we have version-specific references to other projects [1]. Note that this doesn't mean the URLs are actually valid - we need to do more work (linkcheck?) here, but it's an improvement nonetheless. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
2019-05-15Blacklist bandit 1.6.0confi-surya1-1/+2
There's a regression[0] in bandit 1.6.0 which causes bandit to stop respecting excluded directories, and our tests throw a bunch of violations. Blacklist this version, but allow newer versions as there is already a pull request[1] to fix it, and I expect it will be included in the next release. [0] https://github.com/PyCQA/bandit/issues/488 [1] https://github.com/PyCQA/bandit/pull/489 Change-Id: I4429614a57fb512fe2bfdf0686c3eff0adc2a2f4
2018-03-16Follow the new PTI for document buildNguyen Hai1-0/+7
For compliance with the Project Testing Interface as described in: [1] https://governance.openstack.org/tc/reference/project-testing-interface.html [2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I302aced3b50b038900375e9632ca7ed136f32914