Commit Graph

4 Commits (master)

Author SHA1 Message Date
Andreas Jaeger 69f4b79813 Switch to newer openstackdocstheme version
Switch to openstackdocstheme 2.2.1 version. Using
this version will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also

Change-Id: I10e31a8883739e8844b9d974cf4da62cfc28efe0
3 years ago
Andreas Jaeger 2bf5e4c0b3 Cleanup docs building
* Switch to newer openstackdocstheme version and remove values that are
  set now by openstackdocstheme.
* Remove py2 requirments for docs, we only build with python3.
* Update deps for docs building, we don't need the default.
* Remove modindex, this is not build, see

Change-Id: I6958cbed944de0a1eea02de10c5a4916b6a7293d
3 years ago
caoyuan 9ccf7cf414 tox: Keeping going with docs
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


Change-Id: I96e52fe2f0b14d359f37964c3bd51b1ba985dac0
4 years ago
Stephen Finucane 8ec74422a0 docs: Add separate 'doc/requirements.txt' file
Just to help us separate the documentation-focused requirements from
everything else.

Change-Id: I69e9290addd4424fd8360bffcabc118824a24e20
Signed-off-by: Stephen Finucane <>
4 years ago