Switch to openstackdocstheme 2.2.0 that can link to PDF document,
enable this with setting openstackdocs_pdf_link.
Depends-On: https://review.opendev.org/728938
Change-Id: I103a90d4fa101fd261b2b1a86d0a42b9591accc9
Switch to openstackdocstheme 2.1.2 and reno 3.1.0 versions. Using
these versions will allow parallelizing building of documents.
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.
Remove duplicated variables.
Depends-On: https://review.opendev.org/728432
Change-Id: Icb604b31150a1ad6c29a9a4a934ed13f8a0b4976
Remove some cruft from Sphinx config files, drop the use of 'u' prefixed
strings, which are unnecessary in Python 3, and generally tidy stuff up.
Change-Id: Ib0f33576e160ec842d7fc82b4fcfee99829623d7
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Also reorganizes the document structure to match both HTML and PDF docs.
Story: 2006100
Task: 35143
Change-Id: Ie3f38e2ecf52e6a6cbd52bb36196e6f589f1ca0f
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Icd8404026ff5a73129a22b6c89b5cfd6c57432fb
All modules of novaclient.v2.contrib have been removed.
The 'only_contrib' parameter for the
'novaclient.client.discover_extensions' method is no longer valid.
Change-Id: I6da83057dda1f27afe98a2412bc0815f100f34a4
These were missed for some reason. Let's add them now.
While we're here, we add the '-d DOCTREE_DIR' argument to our
'sphinx-build' call to handle Sphinx 1.8's change in behavior for where
doctrees are output.
Change-Id: I5c862a74f92a44bf5248f858e26826eef76c11f0
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
The spec [1] recommends the following sections:
- install
- contributor
- configuration
- cli
- admin
- user
- reference
Only a few of these are useful here:
- contributor
- cli
- user
- reference
Add these and populate them.
[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration
Change-Id: I8a9ddcc915f25ebfaa1e994dba6c15883bd2715d
Autogenerate the nova client python API module list rather than having
to remember to add new modules; use exclude to blacklist modules that
shouldn't be included in autodoc.
Change-Id: I051a7094f3b536f1e9a939af87e3fc89554fb375
In doc/source/conf.py, there are some missing files
(modules) to generate API references.
So add them.
Change-Id: I39689a31084e0cdbfdcad66c723a87de009a08f7
Closes-Bug: #1651043
The following files have been removed in
I09a6501603667350f49b1b1fa130353a6d5272a2.
* novaclient/v2/volume_types.py
* novaclient/v2/volume_snapshots.py
But doc/source/conf.py has not been fixed.
So fix it.
And return parameter format in novaclient/v2/hosts.py
is fixed.
Change-Id: Icd3c5aed776df291141b8c3df4d64aa234e4ed88
Closes-Bug: #1648007
The Nova V3 API no longer exists. Although a version of the framework
exists in Nova as part of the new V2.1 API which is equivalent to
the V2 API there is no need to make mention of V3 in the novaclient
documentation.
In future we will be distinguish between legacy Nova API support (one
implementation of V2) and microversions Nova API support (the
new one) to reduce confusion around version numbers which will change quite
a bit without the framework changing.
Co-Authored-By: Andrey Kurilin <akurilin@mirantis.com>
Change-Id: Id0ff51e1165cb267045d7a63aff13c0e41336738
After wanting to do a rather simple thing -- figure out of the
"timeout" argument to nodepool was a int or a float, it lead me down
the rabbit-hole to python-novaclient.
It turns out the timeout does get passed through to requests as a
float so that mystery was solved.
But the "Client" class seems to be missing from the documentation as
it's not included in the class list. So add that and also at least
document the types of the arguments.
However, then I noticd that this wasn't showing up; turns out sphinx
requires "autoclass_content = both" if you want it to document
__init__() functions. Several other classes had their init args
documented but they weren't showing up because of this.
Change-Id: I8f44e92f2a0f25a75926b1813a8b374e79b4f5db
docs config contains variables 'version' and 'release', which is a little bit
outdated. Since these variables are not used, let's comment them(they can be
helpful in future).
Change-Id: I39f41002f69efc48841e7703b0c767bda0448c09
Module novaclient.v1_1 is used as implementation of V1.1, V2 and V3.
Since future development(microversioning) will be done across V2,
implementation should be done in appropriate module(to prevent misleading).
Despite the fact that implementation for all versions are equal, discover
method for contrib path worked only for v1.1. This patch fixes this bug and
modifies shell tests to check all versions.
Change-Id: Ib6798f4dfe177586302141f522dc593560ce6a5b
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
Directory doc is excluded from pep8 check in tox.ini, since we
modified file doc/source/config.py, we should enable the check.
Change-Id: I057f1e6cb1c5f9a6a07043056078e4475f66f288
The right module name should be `novaclient.v1_1.servers' instead of
`novaclient'. Similar fix on `images', `flavors' and `exceptions'.
Removed `ipgroups' and `backup_schedules' since they do not exist any
more.
Closes-Bug: #1056478
Change-Id: Id35f9c275fb36f3651a0bb2b0eb03c43f0aaeec1
Python3 enforces the distinction between byte strings and text strings
more rigorously than python2. So use six.text_type/six.u()
where appropriate
Change-Id: I890e19cb857e10f0292aabdaebaa8e7a7bd8db23
Signed-off-by: Chuck Short <chuck.short@canonical.com>
- Changes theme to default instead of nature.
- Explains in terms of Compute API instead of Rackspace
- Remove outdated reference to nova-manage command
- Remove unnecessary whitespace
Change-Id: I43d16cd053af0b4be48450fd638f9d17f9e5c4e7
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.
Change-Id: I868df12e3c15cc30043e782ce0a609b9574295cd
Andreas Jaeger