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
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
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
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
f6712f5 Print the reverting back to v1 to stderr
2c7da7c Invalid output running the command 'glance image-show <image_id>'
5026774 Don't make `help` require auth parameters
75ec903 check for None value in utils.safe_header
f0b30f4 Updated from global requirements
1322fbc Consider `--os-token` when using v2
47423eb Check if v2 is available and fallback
90b7dc4 Update path to subunit2html in post_test_hook
1e2274a Password should be prompted once
Change-Id: I70329b9596421a4d8c0c953c19759a96f29c8b0d
Changes included in this release:
$ git log 0.18.0..HEAD --no-merges --oneline
dfa98ab Updated from global requirements
6cb26fc Include owner and status option in v2 image list
5d933b0 Fix Metadef Object update issue with python-glanceclient
9f5c581 Fix functional tests in gate
1686d6a Do not crash on homedir mkdir
1f89beb Improve import related error handling
583adc3 Check image-download for redirection
9c172fb Add some basic CLI functional tests
bf413a6 Use assertIn instead of assertTrue in tests
6431fae Unorder compare in tests
5fa71aa Add release notes for 0.18.0
6d31116 Update README to work with release tools
71d9783 Create functional test base
f2a8a52 Move unit tests to standard directory
f931a20 Fixed doc example
Co-Authored-By: Louis Taylor <louis@kragniz.eu>
Change-Id: Ied7f5b4f298e2bbf4a5486eb6b7dbcea2d0e74d3
Changes included in this release:
$ git log 0.17.0..0.18.0 --no-merges --oneline
8b4456a Uncap library requirements for liberty
76c9f68 Add unit tests for log_curl_request
bd0aa06 Fix https stack trace on python 3.4 client
c698b4e Fix client when using no ssl compression
64a1a0f Add SSL cert verification regression tests
c730266 Omit 'locations' as image-create parameter
a6234d1 Creating task with invalid property crashes in py3
fd2f989 Don't accept *args for client
e386e44 Stub authentication requests rather than plugins
27f70bb Remove keystoneclient mocks
02b1a05 Replace mox in tests with requests-mock
90407d9 Expose 'is_base' schema property attribute
2c08b40 Validate tag name when filtering for images
13b5a5a Remove redundant FakeSchemaAPI __init__ method
c149a94 glance image-show now have --human-readable option
42d7548 Test unit for checking update active images
6d864ef Correct help messages for image-update command
f272ab3 Generate API documentation
a1bb3eb Use any instead of False in generator
Change-Id: I687bef82afd7bb9a379297d7128a009cc051ca75
$ git log 0.16.1..HEAD --no-merges --oneline
db5d729 Updated help for v2 member-update api
3f3066b Extend images CLI v2 with new sorting syntax
bbd27d5 Add the ability to specify the sort dir for each key
976fe17 Import sys module
fc79467 Adds the ability to sort images with multiple keys
f00f769 add examples for properties and doc build script
f6f5733 Apply expected patch format when updating tags in v2.images
a9a692b v2: read limit for list from --limit in shell
0ab5a78 Fix leaking sockets after v2 list operation
f98ab68 Fix leaking sockets after v1 list operation
6e0b1f4 removed excessive call to os.path.exists
b47925e Unit tests covering missing username or password
b64dba8 Remove duplicate 'a' in the help string of --os-image-url
6d21959 v2: Allow upload from stdin on image-create
4c7c7ad Fix v2 image create --file documentation
eeef763 Fix minor typo in version error message
Change-Id: I90d7e4a5109d82e25a63135e94193f4c4f7d4f34
Release notes for the following commits:
$ git log --oneline --no-merges 0.16.0..HEAD
96871b9 Fix tests failing if keystone is running locally
2d67dfa Unify using six.moves.range rename everywhere
af29e0a Show error on trying to upload to non-queued image
ef9fd9f https: Prevent leaking sockets for some operations
01caf4e Strip json and html from error messages
7ee96cb Register our own ConnectionPool without globals
1d82396 Remove graduated gettextutils from openstack/common
a755d1f Workflow documentation is now in infra-manual
Change-Id: Ieed106bff9aa95a7d40b0c39717aa16db4ddbf7e
This adds release notes for the following commits:
$ git log --oneline --no-merges 0.15.0..HEAD
f7cdc3e Glance image delete output
a3eaafe Updated from global requirements
e99e0c8 Change oslo.utils to oslo_utils
96ff6e4 Return 130 for keyboard interrupt
db743e3 Ignore NoneType when encoding headers
869e6ac Use utils.exit rather than print+sys.exit
5ec4a24 Remove uuidutils from openstack-common
93c9bc1 Add a `--limit` parameter to list operations
9daada9 Fixed CLI help for bash-completion
878bdcb Remove openstack.common.importutils
b818826 Remove openstack.common.strutils
35c9b65 Adds basic examples of v2 API usage
363b170 Sync latest apiclient from oslo-inc
f210751 Close streamed requests explicitly
62df6c6 Handle HTTP byte returns in python 3
aebbcff Updated from global requirements
cb046bc Add validation to --property-filter in v1 shell
6eaaad5 Make non-boolean check strict
9054324 Disable progress bar if image is piped into client
df02ee8 Fix Requests breaking download progress bar
e3600ad Fix broken-pipe seen in glance-api
b96f613 Update HTTPS certificate handling for pep-0476
8e8dde2 Output clear error message on invalid api version
bd73a54 Add os_ prefix to project_domain_name/id
465c5ce Curl statements to include globoff for IPv6 URLs
9dcf3f1 Reduce the set of supported client SSL ciphers
Change-Id: Ib97fd745f1f6761b88246351ce2c63d11ad29b01
As a new user I found navigating the documentation difficult. The
flow was a bit unclear and searches bring up old versions of API
references that aren't included in the current documentation.
This
- provides an introduction to the tools similar to other projects
- generates API references for the v1 and v2 client
- fixes some minor docstring issues
- adds doc/* to pep8 tests to check the conf.py
The API generation code is cribbed from python-novaclient
Change-Id: I65772127679d7afd5e7e48ca7872366b01382f21
This adds release notes for the folowing commits:
$ git log --oneline --no-merges 0.14.2..HEAD
9a4d858 Support Pagination for namespace list
3989cd2 Support schema types with non-str value
9829d7b Don't require version to create Client instance
8e02b2a Allow --file in image-create with v2 Image API
d5a0e65 Add useful error on invalid --os-image-api-version
49f38a4 Add release notes for 0.14.0 - 0.14.2
5080d10 Send `identity_headers` through the wire
d0851c3 Remove readonly options from v2 shell commands
4194a55 Add --property-filter option to v2 image-list
ef0abdc Fix py34 failure for glance client
8c159a2 Don't set X-Auth-Token key in http session header if no token provided
b83a672 Refactor method of constructing dicts in some tests
751e064 Adds tty password entry for glanceclient
597da8a '--public' ignored on image create
cbbfbc9 Fix to ensure endpoint_type is used by _get_endpoint()
12a3a82 Add bash completion to glance client
Change-Id: I24fbba80831c311b42d1abb08487cc29c8b5b162
Andreas Jaeger