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.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
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: Iafd5fb0f99a2b68c6f4a3118bf7d7c3a8881465f
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
- Remove install_command from tox.ini, the default is fine
Change-Id: I623b1e0bfc2ec8cd9ce017556101cdeb06a1bb4c
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: I8aad9f2c5f610f8f5241fdddc21ea2a0536d1fd3
The line of "coding: utf-8" is added by some editors automatically.
It is useless, can be removed.
Change-Id: I50ded5ec5140cfbcfdaa1a09ac816e6c88969000
When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.
Change-Id: I1e1865dfcd76eb7f06dd28a5b3b401c5625fcdde
Closes-Bug: #1552251
There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.
Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
os.popen() is deprecated since version 2.6. Resolved with use
of subprocess module.
Change-Id: I71241cc8d47d1be4dcb20924937cb1c25afbc240
Partial-Bug: #1529836
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: I1893fa76affb5e712abef6765e373077b2fc6832
This patch extends some of the docstrings in the `Client` class with
more useful information. The patch also adds `intersphinx` to allow for
linking to other docs within zaqarclient. For example:
:rtype: :class:`zaqarclient.transport.base.Transport`
will link to the documentation for Transport if it has been generated.
Change-Id: I928d63d74739e9e18709979e79c95b5606d97032
Zaqar's client library is lacking of any kind of documentation. This
needs to be fixed, hence this patch. The patch adds the docs'
infrastructure to start writing the required documentation for the
library.
Change-Id: Ife171e352da4ec977202efcb3f1dcf573edcdc27
