All strings are considered as unicode literal string from Python 3.
This patch drops the explicit unicode literal (u'...')
appearances from the unicode strings.
Change-Id: I52ae9180344baf408e6e8a932e9d59dc45ece9de
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* parallelizing building of documents
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.
Set openstackdocs_auto_name to use 'project' as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I76a21521eeb432c3f4089048a4635719ba6d785c
* Remove doc/source/install/conf.py, it's unused.
* Remove settings that are provided by openstackdocstheme from conf.py
files. Switch to newer openstackdocstheme for this.
* Remove unused deps from tox.ini: releasenotes and api-refonly need
doc/requirements but not requirements.
Change-Id: Iab5ad6cde40c3342770c0112155fe5e1d262d1e8
Fix the pep8 E402 (Module level import not at top of file) errors.
For the Alembic files move the definitions of 'revision' and
'down_revision' below the imports. This is now done in Alembic [1]
For other files fix as needed by moving the imports or lines before
the imports.
In a few cases add a "# noqa E402" to whitelist the issue.
[1] dc2aae0374
Change-Id: I48c96d5da0cb747b3ca3fceea9b4ffa85a9ebe22
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.
[1] https://review.openstack.org/532163
Change-Id: I1725e25dd13bfe14c83f3f679092fc36fa6cb208
The os-api-ref 1.0.0 is out. We can remove the support to older version now.
Reference:
6d41feb58d
Change-Id: I14266932bf6f936991f1ea675f3e61431b4a0b1c
Currently, Ironic api-ref is configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/ironic/"
Change-Id: Ifb0e34a41807f87ae4d5402064b63b76e89ec0b4
The html_last_updated_fmt option is the output of a shell command, which
is interpeted as a byte string in python 3 and subsequently breaks
Sphinx.
This change converts it to a utf-8 string.
Incidentally, this also removes the quotation marks to make the
formatted output cleaner.
Change-Id: I9aa6446a24d2f340246458dea0c34d456b3eade3
Closes-bug: #1583721
os-api-ref is released on pypi now, so we can move to using it instead
of our in tree version.
Change-Id: If353f4a2e553fa3da3b2a4c920e233f51365b77c
Depends-On: I0e615d36a2e5a8fa0d83f20bdcc2c33ad868ebd5
Per this email[0], it's time to migrate our API docs into our tree.
This copies the sphinx extension from nova into our tree as well, which
will be later split into its own python module. At that time we can cut
over to the module and drop it from our tree.
The conf.py and the tox environment are also cribbed from nova.
[0] http://lists.openstack.org/pipermail/openstack-dev/2016-May/093765.html
Change-Id: I683cc4d6459d77c42951a06247b6f9ff8f8456bd
