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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I5f985549671e3b4f8c438f247fae0818d25b21f5
Addressing feedback from
https://review.opendev.org/675762 . These comments are wrong
with current openstackdocstheme, so remove them completely.
Change-Id: Ibfb3a2e37ea5b89ce81caed3e4884ee077e0d967
Use sphinx-build and cleanup unused config.
Switch to openstackdocstheme 1.20.0 and remove obsolete settings from
conf.py files.
Update some RST files, they had wrong indentation.
Change-Id: Iaad2841db809f8a343fb8b1031cf8d0587d70442
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
at
http://lists.openstack.org/pipermail/openstack-dev/2017-November/124480.html
.
Change-Id: I594c14139dd8a3b313e95898ff86508fc7a40878
There were a couple of scripts here:
- prettify.py
- remove_trailing_whitespaces.sh
- remove_unnecessary_spaces.py
- retf
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.
Change-Id: Ifbd2d50a669251484056552da21d23906f8d6178
The 'openstack-auto-commands' command has been superseded by the
'cliff.sphinxext' Sphinx extensions [1]. Remove both this and the helper
script in 'bin/doc-tools-update-cli-reference'.
[1] https://docs.openstack.org/cliff/latest/user/sphinxext.html
Change-Id: Ia20ace51377290997566b89ad4f78a941358cb86
Update to use current openstackdocstheme everywhere instead of
oslosphinx, remove now obsolete settings.
Change-Id: I812f72ebf9fb4d96b1031880c44596833da9d384
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.
Change-Id: I135caa57e1dcdd4114033276d89fc87c28a71aac
We don't support Docbook anymore and this didn't work due to missing
templates. Kill the subcommand.
Change-Id: I38514946a48804c0eb50614ea31553e2b01135ac
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.
Change-Id: I5da1d06866c16a8c56be23e87817d163b28803a8
Releasenote translation publishing is being prepared. 'locale_dirs'
needs to be defined in conf.py to generate translated version of the
release notes.
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.
Change-Id: Iace1593dff20324b86c7245c2217d51d77d9a465
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
builds.
This allows those superior builds to be rsynced without removing the
other builds that were published under them.
http://specs.openstack.org/openstack-infra/infra-specs/specs/doc-publishing.html
Change-Id: Ic8773caebecafa87b10c1ad4612bde6b1513b667
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.
Change-Id: I5589bc634e1f630f79b3d6e8bffee939c5300bf2
To migrate CLI Reference from DockBook to RST,
output the documentation in RST format,
with a few work around for RST/Sphinx specific issue.
Change-Id: I32b4cfefa978436061d882f7520bbc92c1645b4e
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> ... ]
Change-Id: I9fd0b763b6e56cd360694566de7f3acc3172c9c1
Closes-Bug: #1522794
Split up draft guides under separate heading and remove draft word for
easier review.
The output looks now basically like:
Generated documents
admin-guide-cloud
contributor-guide
networking-guide
user-guide
user-guide-admin
Draft Guides
arch-design-rst
config-ref-rst
image-guide-rst
install-guide-debian
install-guide-obs
install-guide-rdo
install-guide-ubuntu
Also, create separate tool openstack-indexpage that only generates index
page.
Change-Id: Ic68a674918f18dc37f8b9fa4e9d9f529a8ad131e
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
Change-Id: Ib7a14cc52337fc1abd8b02a8ff33396c0b992746
Mark RELEASE_NOTES.rst as obsolete and give pointer for new work flow.
Move one entry from current RELEASE_NOTES to reno.
Change-Id: I94d81e00d0a4405c1dfce9fdb83a2ec6f26eae5a
As suggested by Doug Hellmann, properly define the release-notes to
automatically generate content.
Change-Id: I4c2f9086d40ef428239943240f61c74cf16e1ab6
Andreas Jaeger