Currently, tox-edocs fails with the following error message:
Warning, treated as error:
autodoc: failed to import module 'shell' from module 'glanceclient'; the
following exception was raised:
No module named 'six'
We used to install six in the virtual environment through keystoneauth,
but keystoneauth no longer depends on six. Let's mock six completely in
the context of autodoc.
Change-Id: Ibcf0b9698227a2c22fe991b7516ba5dceabfc607
Boolean options (such as "--protected" for glance md-namespace-update)
should accept a limited amount of valid values, rather than assuming an
"invalid" value means "False".
The following values (no matter the case) will now be interpreted as
True: ‘t’,’true’, ‘on’, ‘y’, ‘yes’, or ‘1’.
The following values (no matter the case) will now be interpreted as
False: ‘f’, ‘false’, ‘off’, ‘n’, ‘no’, or ‘0’.
Change-Id: I0e7942045d883ac398bab4a7a85f2b4ac9b1ed8c
Closes-Bug: #1607317
This commit:
- removes the old "u" prefix from all strings
- removes the unicode_key_value_to_string function
Change-Id: I1da347e31e828fd2359f0935a4da47257116d4cb
We currently have support to show verbose output for image-list
with the command ``glance --verbose image-list`` but there is
no documentation about it.
This patch adds the documentation and a test to run it via CLI.
Closes-Bug: #1969565
Change-Id: Ic6db4f5ab2fecded373b044aa002f9a9bc262513
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: Ie4aec288c74b9bd8d8d117f4bc2e0282cea4db90
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Update classifiers
- Update requirements, no need for python_version anymore
Change-Id: I6b6dfb0959973abf0c2e8325006025db2a5d85d0
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Change-Id: I2577ca452a014402f1377474457095176d422b42
Sphinx 2.0 no longer works on python 2.7, so we need to start capping
it there as well
depend on https://review.opendev.org/#/c/657890/
Change-Id: Ic77e0db24ab7d7f068faf3e237beefa8856a710a
We use MD5 for checksum, add this description
in cli helps.
Change-Id: I3469b0dface63f4684ad39421eee4c2a2de4d80b
Signed-off-by: Chen Hanxiao <chenhx@certusnet.com.cn>
The list of useful image properties really belongs in the Glance
Administration Guide. The only connection they have with the
glanceclient is that you can use it to set them. Rewrite the
property keys document to reflect this. The dependency moves the
relevant text to the Glance Admin Guide.
Depends-on: https://review.openstack.org/565780
Change-Id: I39add6728aad42988a07d2ad97cd81dbdaf4c54a
- Add a simple introduction for the original parameters
- Add two necessary parameters for Identity API v3:
- user_domain_{name|id}
- project_domain_{name|id}
Change-Id: Iebd9bb57fcdbd6abb8fc369e69ba52805fb77170
Old deprecated ssl options block the new keystoneauth parser get the
correct value, should be removed.
Change-Id: Ie080f9a8fa7f4407b1fcbb7fb7c763152c5ec295
Closes-Bug: 1697163
Add documentation for the image import commands, particularly
pointing out that the image-create-via-import command is an
EXPERIMENTAL command that my be renamed or removed in a future
release.
Change-Id: I20ebc0145db6acc794039ed25e7754ec8d479bc8
--no-ssl-compression is deprecated and no longer used. So, it is
removed from the help message.
Change-Id: I2b886671a568ed191ee380cf16335ccd9ae85062
Closes-Bug: #1583919
--profile argument can be loaded from OS_PROFILE environment variables
to avoid repeating --profile in client commands.
Correct/update help text.
Co-Authored-By: Hieu LE <hieulq@vn.fujitsu.com>
Change-Id: I67c1e4b859b972e380eb658c98ceae4fbef5c254
1. Update URLs according to document migration
2. Update the dead and outdated links
3. Optimize (e.g. http -> https)
Change-Id: Iad743ad223b8c40ae914beccd936f71a81622d76
https://review.openstack.org/474775 moved glance.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: I2c37755553d1265fb9fb069067c4468853f395b7
Fix a formatting error in one docstring and turn on the flag to ensure
that future warnings in the doc build trigger a build failure.
Change-Id: I7159b985d1690a8ae61ff885408da4623c105952
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Set some of the new config values and enable openstackdocstheme as an
extension so it will inject values into the page context as it writes
each documentation page. This ensures the pages link to the right bug
tracker, etc.
Change-Id: I316bd585f91064af4d1d1e7b834986619fc3a2d3
Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This patch rearranges and reformats existing content.
It replaces the home-grown autodoc feature with the one built into pbr,
for consistency with other OpenStack projects.
It depends on the doc-migration spec and a pbr feature to allow us to
specify where the autodoc content should go in the source tree during
the build.
Change-Id: I8d2bb11b5ef3e46fcd22c8bed8f84060d8ab6f03
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Depends-On: I2bd5652bb59cbd9c939931ba2e7db1b37d2b30bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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. Enable this.
Change-Id: I39ffb22c37a05f00cade2fbd14449eaf77dc3d39
When docs are generated with pbr command 'warnerrors = True'
there are many doc problems that are shown. This patch fixes
these problems.
Change-Id: Idb804ab924782b6d7d379494987bdba2acbce568
Closes-Bug: #1557235
1f1934e Add versions list function
bff356e Added reactivate/deactivate image using CLI
dfcb468 Fix the missing help descripiton of "image-create"
8a4cd79 Add documentation for running the functional tests
c7c0754 Updated from global requirements
d6a10f2 Remove unused sphinx Makefile
5a24705 Update docs to recommend KSA instead of KSC
84538d8 Use clouds.yaml from devstack for functional tests
4fb3092 Add translation to v2 shell
6b9133c Import i18n functions directly
8cf2bfc Updated from global requirements
b51634a improve readme contents
ca050ed Add support for setting Accept-Language header
3bd28bf Updated from global requirements
36937bb Use the subcomand parsed args instead of the base
afd1810 Stop trying to send image_size to the server
bf02b04 Support image deletion in batches in v2
a8a7c68 print usage when no argument is specified for python3
77012ee Updated from global requirements
603697a Updated from global requirements
df0f664 Do not use openstack.common.i18n in glance client
abf0381 Added unit tests for 'Unicode support shell client'
1f2fefb Use common identity parameters fro keystone client
c31c136 No auth when token and endpoint are passed
557acb1 Use dictionary literal for dictionary creation
c6addc7 Replace exception_to_str with oslo.utils function
586d401 Change ignore-errors to ignore_errors
05cd0c7 Add period in help message
b8a881f Don't get the image before deleting it
3d3d829 Fix human readable when size is None
19480df Add parsing the endpoint URL
22ce845 Fix Typos in comments
b9eee5e Add check Identity validate when get schemas
Change-Id: If2964135d73b45a11faf03b7dfa6b6f756a1abe0
The appropriate way to build sphinx docs in OpenStack is:
tox -evenv -- python setup.py build_sphinx
Change-Id: I95dbab8b72cf40fb399703c01bf1a116fcffd4be
For the session workflow (which is really the only workflow a dev should
use), session objects should now come from keystoneauth1 instead of
python-keystoneclient.
Change-Id: Icb5f20ce3dc09ff7790b27d07f7f0cb3b83e1e7e
Cyril Roelandt