Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
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.
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.
Use sphinx-build and cleanup unused config.
Switch to openstackdocstheme 1.20.0 and remove obsolete settings from
Update some RST files, they had wrong indentation.
Release notes are version independent, so remove version/release
values. We've found that projects now require the service package
to be installed in order to build release notes, and this is entirely
due to the current convention of pulling in the version information.
Release notes should not need installation in order to build, so this
unnecessary version setting needs to be removed.
This is needed for new release notes publishing, see
I56909152975f731a9d2c21b2825b972195e48ee8 and the discussion starting
There were a couple of scripts here:
Most of them are self-explanatory with the exception of 'retf', which I
don't understand but which looks untouched in years and therefore
useless. For the other three, we have tooling in place to ensure these
"issues" don't get into source control and, even if they did, there's
questionable value in rewriting stuff just to remove excess whitespace.
Kill them all.
The 'openstack-auto-commands' command has been superseded by the
'cliff.sphinxext' Sphinx extensions . Remove both this and the helper
script in 'bin/doc-tools-update-cli-reference'.
Per the comment on change 'If0cf66aa9', we no longer track swift config
files as part of openstack-manuals. As such, we can remove the special
casing for this project.
Do not give sphinx-build as single argument, split it up.
tox 2.5.0 currently complains that it cannot find "sphinx-build arg1
arg2" - so, pass this properly now.
Add releasenote for this.
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
Note that this repository might not get translated release notes - or
no translations at all - but we add the entry here nevertheless to
prepare for it.
This is needed for publishing in the future:
This is so that we can create a list of directories to ignore when we
rsync documentation builds to a publishing site. Some builds are
published as subdirectories underneath the results of superior
This allows those superior builds to be rsynced without removing the
other builds that were published under them.
openstack-doc-test is used for building of DocBook XML files. For index
page generation openstack-indexpage can be used.
Remove openstack-doc-test together with all support files.
To migrate CLI Reference from DockBook to RST,
output the documentation in RST format,
with a few work around for RST/Sphinx specific issue.
Implements: blueprint cli-ref-rst
We want to be able to change the section in which an option is
registered in the documentation. This patch uses a <project>.overrides
file to define in which section(s) an option should be moved.
The format of this file is (1 line per option):
[<group>/]<option> <new_group1>[ <new_group2> ... ]
Split up draft guides under separate heading and remove draft word for
The output looks now basically like:
Also, create separate tool openstack-indexpage that only generates index
The extract_swift_flags.py script parses the existing docbook tables to
discover documented options. We're now switching to RST so implement
reading from RST tables, and make it the default behaviour.
Implements: blueprint config-ref-rst