Our CLI docs are very out of date. These used to be generated by the
docs team with some tooling they had. Since the docs moved in-repo, that
tooling has gone away, and for the most part no one has done any updates
to the CLI docs.
This adds a sphinx directive that will generate these docs every time
the docs are built. This way, whenever someone makes a CLI change, they
do not need to have to know to also edit a documentation file to match
their change. Any code changes will automatically be picked up and
reflected in the docs.
Change-Id: I4406872ab6e9335e338b710e492171580df74fa5
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
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. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_auto_name to use project as name.
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.
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: I2cc022495b162bec1424ec69611acb879900c005
Change I1f43c37c2266e43146637beadc027ccf6dec017e adds time-comparison
filtering to the volume list calls (summary and detail) in the Block
Storage API microversion 3.60. The current cinderclient filter
support will pass these filters correctly, so the only change needed
on the client side is to bump the MAX_VERSION so that the client
can make calls to mv 3.60.
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Change-Id: Ib4b7cbc7e527c0524336e139e127f19accfb7568
Partially-Implements: bp support-to-query-cinder-resources-filter-by-time-comparison-operators
This needs to go to "python-cinderclient"
to work instead of "cinderclient".
Add a "doc" tag to these bugs as well.
Change-Id: I45ae03e9c071dd9b159b1c0183b53db4dd837453
This patch standardizes the CONTRIBUTING.rst file and adds
doc/source/contributor/contributing.rst
Change-Id: I892e49f96573b77b46bd8847a5d2ac8254e8e5e1
Also adds support for py3.6 and py3.7 check and gate jobs.
Co-authored-by: xuanyandong <xuanyandong@inspur.com>
Co-authored-by: Brian Rosmaita <rosmaita.fossdev@gmail.com>
Closes-bug: #1853372
Change-Id: Ia978b692ade23ee6482957f41b17cb879c96fea7
Updates several references for things like OS_TENANT_NAME and
--os-tenant-name.
Change-Id: If71710740b4d4573a1b3f515a5762a4f82bc727d
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The previously choosen PDF file name conflicts in some repos with the
project logos (badge). Thus change https://review.opendev.org/679777
renames the desired PDF name to be doc-PROJECT.pdf to allow using the
badge in PDF files.
Follow this rename.
Change-Id: Ife8461f00ba2206d18ae45837bbc31d211e29841
If OS_VOLUME_API_VERSION is not set, use the highest
supported by both the client and the server.
If OS_VOLUME_API_VERSION exceeds that supported by the server,
use the highest supported by both the client and the server.
A warning message is printed for the user indicating that this
happened.
(This is similar to the behavior of the manila CLI, and is
mostly code from manilaclient tweaked to work in cinderclient.)
Change-Id: Ie1403eca2a191f62169e60c0cde1622575327387
This patch updates tox.ini to build the pdf version of
cinderclient documentation.
run tox -epdf-docs
Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: Icbfa21da1e83f745a98822a2f33c4ebc8d11fd0c
Reference the python-novaclient cli doc. And removed the
"cinder version 2.2.0." in python-cinderclient cli doc to
avoid confusing users.
Closes-Bug: #1831636
Change-Id: I67ef7e532ba46932d9f5d2835a611162140b354c
The replication 1.0 API os-promote-replica and os-reenable-replica
were removed[1], then remove useless code from
cinderclient.
[1]: https://review.openstack.org/#/c/275797/
Change-Id: Icf98f294c089942e11607786e932abc959f77b3b
Doc build keeps failing w/
Recursion error:
maximum recursion depth exceeded while pickling an object
Sphinx recommends bumping up the recursion limit to
get around this, and it appears to work.
Change-Id: If0a78f9af2e4ddd5fd88c44757642355b3a5bf2e
Good lord this thing needed some love. This change
does a few things:
* Remove the duplicate man page.
* Rename some titles to drop the CINDERCLIENT yelling -
this is docs about cinderclient, I get it, no need to
repeat in all caps.
* Fixed the sub-section title formatting in the home page.
* Dropped the duplicate usage guide wording and simply linked
to the user docs from the home page.
Change-Id: I259787a40151e8c875ad87021f655a141e06b15e
In the file doc/source/cli/index.rst, doc/source/user/cinder.rst,
doc/source/user/shell.rst, update OS_AUTH_URL and OS_VOLUME_API_VERSION.
Change-Id: I543bb2fedf3a1326bf1a46804f0d026ad8e21680
Since 3.52, new option '--filters' has been
added to 'type-list' command, and it's only
valid for administrator.
Change-Id: I140f6d61a2747d4fcaabfbccea864dcc7eb841d1
Depends-On: I4e6aa7af707bd063e7edf2b0bf28e3071ad5c67a
Partial-Implements: bp support-az-in-volumetype
The keystoneauth1 get_plugin_loader method requires that a
OS_USER_DOMAIN be specified. Our docs don't include that
detail.
This change adds the extra needed field. There's also some
problems currently with loading the client directly as it's
currently documented, which appears to be a bug in the client
code itself.
Change-Id: Idacbb47f9aae1e461379eec4a5e224b0157a8dc4
Partial-Bug: #1758104
This patch remove unit tests about flags, beacuse the flags
about run_test.sh has delete.
About run_test.sh delete, look this patch.
https://review.openstack.org/#/c/502120/
Change-Id: Ib0e04ed6d48ec5c52cc62abf59174c313d843792
Signed-off-by: Yuanbin.Chen <cybing4@gmail.com>
Update the URL in the document library, and use https instead of http
due to openstack document migration.
Change-Id: I991dff678ce613b0a50e3d0c9ab5ecd8cdf3e272
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate the
setting from the old warnerrors one.
Change-Id: Ifd411ead74497a43ab22c57090ece2e1c7cfddb5
Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f moved cinder.rst from the
doc/source/man directory into doc/source/cli, so we need to adjust
the path in conf.py to avoid issues when running:
python setup.py build_sphinx -b man
Change-Id: I32ca20e0e184b11c68c9b81a9ff3d1247330ade4
This patch is part of the great doc migration from
openstack-manuals to the individual repos. The
changes are based on the spec here:
https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
The cinder.rst file needs to be renamed index.rst so
that the template that is being used by OpenStack
manuals team will magically find the documentation.
Change-Id: Ia3b5ee2b6aaf17781d3de7546a9477f1c928092f
In the file doc/source/man/cinder.rst, add cinder command
examples, In the file doc/source/shell.rst, update OS_AUTH_URL
and OS_VOLUME_API_VERSION
Change-Id: I6ed2c5228daad8dd6dcab1d7278f8a0b049c0490
Update URLs according to OpenStack document migration
BTW: Do some optimization as well (http -> https)
Change-Id: I9239e2012442f3e459a21f50afd380c8f58a6a98
