Change the defaults for the max of a 5 of \begin...\end stanzas,
up to a 10.
Change-Id: I52ef17bd87cbcde7f9dc34e8b1bb874581d0917d
Signed-off-by: Bogdan Dobrelya <bdobreli@redhat.com>
Now that the repo is renamed, update all of the references.
While we're at it, remote unused translation config.
Change-Id: Ib9f80eb809317483f83f79952470c2b57b2bb7c6
From openstackdocstheme 1.18.0, valid Git URLs can be retrieved by
openstackdocstheme[1], we do not need giturl option anymore.
[1] https://review.openstack.org/532163
Change-Id: I1848f43d337d40248fce3f50554e4b5ba294396c
This sucks in the git history for both projects, then moves their files
in place. It should not introduce any behavior changes to any of the
existing openstacksdk code, nor to openstack.config and openstack.cloud
- other than the name change.
TODO(shade) comments have been left indicating places where further
integration work should be done.
It should not be assumed that these are the final places for either to
live. This is just about getting them in-tree so we can work with them.
The enforcer code for reasons surpassing understanding does not work
with python setup.py build_sphinx but it does work with sphinx-build
(what?) For now turn it off. We can turn it back on once the build
sphinx job is migrated to the new PTI.
Change-Id: I9523e4e281285360c61e9e0456a8e07b7ac1243c
Rather than occasionally playing catch-up until the wait_for methods are
removed from the base Proxy in 1.0, we can temporarily ignore those two
names. This allows us to make the doc build fail if undocumented proxy
methods occur.
After 1.0 we should remove the special cases for wait_for names, but
leave warnings_as_errors on.
Change-Id: I8fe41ed639ec318a18db3022371b52382c53aa99
When building packages if git is absent, do not try to get the git sha
via the git cli. That can not work.
Change-Id: I3bde4df045287cbda07c9447ef3397de74f42910
Closes-Bug: #1677463
Previously, the openstack.image.image_download method would place the
contents of a remote image into a Python variable. With this change,
the download_image method can optionally return the
requests.Response object returned by session.get(), which permits
the caller to download the image in chunks using the iter_content
method. This can prevent performance issues when dealing with
large images.
Change-Id: Ie62ebcc895ca893321a10def18ac5d74c7c843b9
Per the approach on https://review.openstack.org/#/c/428276/, and in
general even outside of that change, we should have more strict
enforcement on the inclusion of our public proxy APIs in the
documentation. This tool runs as a part of our doc build, via `tox -e
docs`, and collects all of the public proxy methods and then compares
that list to the list of methods that were produced by Sphinx.
For right now this will only output warnings, but we should eventually
turn on enforcer_warnings_as_errors in doc/source/conf.py so that we can
truly enforce these things. If you don't document something, it'll kill
the doc build and then kill the docs gate job, so undocumented code
won't be accepted. We'll need to leave it off for the time
being as we transition into it.
Change-Id: I96743de7e0790da98d758415e084a26a92aa3c70
For docs set the launchpad project users report bugs
against to "python-openstacksdk". Users can report bugs
using the "bug icon" that will
directly link to the launchpad project, it currently goes to
"openstack-manuals" which is wrong for this content.
This variable is used by openstackdocstheme 1.2.6.
Also, update comments for the variables passed to openstackdocstheme.
Change-Id: Id036c6373092673ce0c54be1b64ea87d1de89b88
Related-Bug: #1524476
Now that we use openstackdocstheme, we don't need to depend on or
include oslosphinx in our doc configuration.
Change-Id: I4ac7c1600a970da39ec3e45907a2353e772620e1
The glossary was not being generated and there were a few other 404s
and warnings that are fixed. Removed old TODO. The glossary could
use some more work, but that TODO had become meaningless.
Change-Id: I7b6c0dc18c46d29a8edc85d22723acb3a25a2c26
This change creates a section of the documentation focused on users,
holding the guides, API docs, etc. Another change will focus on
documentation for contributors.
* Installation details were moved straight into the user index.
Installation details for contributors will go into that section.
* The old usage.rst section was moved into the userguides/ section and
will grow into a Connection guide in another change.
* The sections were organized according top to bottom in order of
likelihood of utility to users. The guides will help people get
started, the API docs will help them go from there, and anyone needing
to customize lower-level things will have already scrolled through the
preceeding sections to get to the end.
* In order to see how the Resource docs turn out to be organized, I
added pages for Compute and Database resources. We'll need to add them
for every service, but I didn't want to overload this change with all
of those additions.
* Since glossary isn't linked in a TOC anywhere, just mentioned
explicitly at the beginning of the user section, I added an exclude
for it in the conf.py. It still gets built, but that allows it to not
become a warning for being left out of TOCs.
Change-Id: If9d1e4726ed14d5b7592c9da00c27591d2a4291c
Partial-Bug: 1416553
Add a section for where Resource classes will show up in the docs and
enter two skeleton pages for how this will look. Later changes will
cover the actual member-level documentation of the Resource classes for
each service, along with their addition to the TOC.
This additionally sets autodoc_member_order globally to "bysource",
meaning it'll order the rendered member documentation in the order it
was written. The default of alphabetical order by what shows up in
__dir__ is not as helpful or as readable as how we've organized the code.
Change-Id: Ifcd7cd81ba55ecb429c50680a926d4f8a44ca9a3
