With sphinx release of 5.0.0, they changed default for language variable
to 'en' from None. With that current None valuable is not valid and should
not be used.
Change-Id: I3fc1dd06c176c7004974b9cd989208f4ba7a37f2
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.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
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: Iaf0ccf47069546ecd3c6931b6fa5dd9fd830ef3a
New version of openstackdocstheme (Victoria+) respects pygments_style.
Since this repo is using now Victoria (master) requirements but has
not branched for Ussuri yet, it uses the new version.
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.
Change-Id: Id592108e606eb1c5771836fd93237050e4759c87
This has been committed to some OSA repos without using the proposal
bot so will be reverted on future runs of the bot. Update the
synchronised file to ensure that there is consistency across all roles.
Change-Id: I70f8218c8add371d35d97f3337765cf170461128
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Cleanup tox.ini for Python 3 only
Change-Id: I9d63e63cf142fded002f7212588266d88f41dd06
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release
Change-Id: Iac130cf465b44a730193547bab4da626cce59e5c
doc8 seems to be complaining with the length of the string in the
requirements file. This patch fixes that and it also updates the
in-repo file so that it gets tested by doc8 as well.
Change-Id: I42613d58ae23db99e3ae7c7d89a9dd865baaba5b
sphinxmark is no longer compatible with the latest release of Sphinx
which is causing all of our documentation jobs to fail. This patch
removes it as our current usage of openstacktheme for documentation
already provides watermarks for current branch and notices for which
branch the documentation covers.
Change-Id: I1037ed595a88503b231f0d9b98c143c1814403ab
Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.
This should solve it.
Change-Id: I82671efeb4cb01b18c98e7d3543fa016acfad765
- gitignore to avoid bad files
- git review to enable git review/gerrit integration
- Vagrantfile like the other repos, but not useful (yet!)
- dummy inventory file
- setup.* files because docs use pbr
- requirements files
- tox.ini for test launcher to match openstack standards
- scaffolded docs and release notes for gates to pass
Change-Id: Iaf78c8fd3c2138e1d7d4384fb83c90cb7ddd6d10
Dmitriy Rabotyagov