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.
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.
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.
Set openstackdocs_auto_name to use 'project' 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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I8e6c4b1d09e5f56b505c6006ea048baf896444c3
Some minor formatting issues caused by openstackdocstheme adoption
in README.rst and HACKING.rst.
Note that the install instruction is part of README, so it is not split
out into a separate rst file (as suggested in the doc-migration spec).
Change-Id: Iac58eeb15921e9225a461e3b5b2f3bd7ac99f415
Remove intersphinx from the docs build as it triggers network calls that
occasionally fail, and we don't really use intersphinx (links other
sphinx documents out on the internet)
This also removes the requirement for internet access during docs build.
This can cause docs jobs to fail if the project errors out on
warnings.
Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb
Related-Bug: #1368910
* Delete old layout files now that we use oslosphinx
* Add fail to build on warning
* Add 'tox -edoc' command (just like nova-specs, keystone, heat etc)
Change-Id: I316c4bb3fe7036ecd8a0fb19d7348c307c0afebe
The hacking guide is in the root directory of every project as
HACKING.rst, except for hacking itself. Keep the hacking guide as the
index to the docs, but move the file to the root directory.
Change-Id: If128dfc004db2b7427f987ea8a9f643b6c653ce8
Hacking originally had a soft preference for () versus \ based line
continuation, but this has lead to unnecessary review churn. So in order
to reduce churn be stricter and don't allow \ based line continuation.
Related ML thread
http://lists.openstack.org/pipermail/openstack-dev/2013-November/019024.html
Change-Id: I010623344bc2c4bf86051f86a96afb3611c90342
The way to using metaclass has changed in Python3.(H236)
Python 2.7 way:
class Foo(object):
__metaclass__ = FooMeta
Python 3 way:
class Foo(object, metaclass=FooMeta):
...
The six.add_metaclass() decorator allows us to use one syntax that
works for both Python 2.7 and Python 3.
Change-Id: I24a00d9e59ffdd9abf4ccf3919737bdb079819eb
Related-Bug: #1236648
Don't include a vim modeline sample in the import ordering section, as
import ordering is not related to vim modelines.
Change-Id: Ibd25c109967b939a0410ddbc332c17b011b21ab9
