/home/zuul/src/opendev.org/openstack/python-keystoneclient/.tox/docs/lib/python3.8/site-packages/keystoneauth1/fixture/discovery.py:docstring of keystoneauth1.fixture.discovery.DiscoveryList:1:duplicate object description of keystoneauth1.fixture.discovery.DiscoveryList, other instance in api/keystoneclient.fixture, use :noindex: for one of them
Change-Id: Id2722a1b275be88af6d0337684f1eb012b7f4ce1
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* 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.
Set openstackdocs_pdf_link to link to PDF file.
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.
Depends-On: https://review.opendev.org/729744
Change-Id: I311a5daa382dfca07e618eb6cbb3f44bd0502b02
Use sphinx-build so that the output happens in the right place.
Remove ChangeLog, instead link to the release notes.
Use apidoc for API doc building.
Fix main index page display so that title has higher level,
use link to OpenDev.
Change-Id: Iaa8d7f2143d411be31ad10b546455f18015566f3
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete section from setup.cfg: Wheel is not needed for
python 3 only repo
- Update requirements, no need for python_version anymore
- Remove future import from doc/source/conf.py
Change-Id: Ibf594171cea8f81cc4139b29cbdce54f6d5107a7
This patch adds a new tox job/command for building the pdf
version of documentation.
tox -epdf-docs
Change-Id: I0c0ef99190ea2a834bfdb47eb443b88a93bc802c
Some options are now automatically configured by the version 1.20:
- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release.
Depends-On:https://review.opendev.org/#/c/660609/
Change-Id: I83ee2a89ae0a8158ed955581b738cea6ca93707d
Due to latest change in docs the old urls don't work and cause gate
failures. Fix it to reflect the new locations.
Also temporarily drop reference to keystoneauth1 to prevent circular
dependency. This reference will be brought back after keystoneauth1
docs get fixed.
Change-Id: I7e170275fd422345505b7282b52899d08c7a4172
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.
[0]https://review.openstack.org/#/c/472275/
Change-Id: If3a8f6668d0a4e32bd8a20330d973249ce6a5b46
html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.
In addition, changing Popen to check_output because
check_output() will raise CalledProcessError if the called process
returns a non-zero return code.
It also makes the code look much better.
Change-Id: If01f08216b4b252bd31029913e83fe945bf76866
Closes-Bug:#1693670
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.
Change-Id: Ia6cdaf7fabd1c355df002aa07b0695610dde9cd1
Documentation build fails during packaging if Git repository is absent.
We do not package .git directory and that is why it leads to fails during
documentation build.
With this change we are certain that it will not fail.
This change was originally proposed by Davanum Srinivas (dims):
https://review.openstack.org/287448/
Change-Id: I49dce2537ea26c168af9a67d398930042702762c
the CLI has been deprecated for a long time, and many docs and
install guides recommend using OSC instead of `keystone`.
- removes CLI
- removes man page from docs
- removes CLI tests
- removes `bootstrap` from contrib
- removes entrypoint from setup.cfg
implements bp: remove-cli
Change-Id: Icbe15814bc4faf33f513f9654440068795eae807
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Change-Id: I53c21d6e8a9d23646c236ae33d652f1aefc20153
Closes-Bug: #1529836
To allow people to use a keystoneauth session with keystoneclient we
need to make it so that any exceptions that keystoneclient catch are the
same as what keystoneauth might throw.
The only practical way to do this is to map the keystoneclient
exceptions onto the keystoneauth equivalents. This is fairly easy as all
these exceptions were extracted from keystoneclient initially.
Closes-Bug: #1515048
Change-Id: I3b74b0ba1e1f9dda937a2d90e2d75ff0b7597a9b
A temporary fix was added to get around a bug in how pbr handles
its autodoc_tree_index_modules setting. Since this bug is fixed we no
longer need the work around.
Change-Id: Id8274ef5c244bf50a34702ed9b4e50d3b82d8028
Closes-Bug: #1260495
Correct the type signature of some API documentation. Add inter-sphinx
mapping to documentation to provide links to external docs. Correct some
phrases and errors.
Change-Id: Id4a71a9901e5adc695afed656e3bc84e4e54e67a
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
None of our documentation references any external sphinx documents so we
don't need the intersphinx mappings.
This started as a rename from the old glance.openstack.org site to the
newer docs.openstack.org/developer/glance however they may as well be
removed if not used.
Closes-Bug: #1353817
Change-Id: I638c4eeab7d01ec2f26a0d9d532f0006f4f75e72
The module docs were not being generated.
Co-Authored-By: David Stanek <dstanek@dstanek.com>
Change-Id: I26e1d9a3d407474eb6b016f3ada4c495b5043460
Closes-Bug: #1278662
This patch adjust import items and add missing blank lines acording
to http://docs.openstack.org/developer/hacking/#imports
{{stdlib imports in human alphabetical order}}
\n
{{third-party lib imports in human alphabetical order}}
\n
{{project imports in human alphabetical order}}
\n
\n
{{begin your code}}
hacking project also enforce some checks for import group.
Let make the change in keytoneclient
Change-Id: Ic83bd5ee426905588f4a2d555851a9a01fc69f02
use "from future import unicode_literals" instead of u""
To the road to Python3, a possible next step would be to use the from __future__ import unicode_literals
and remove the u'' prefixes, as it is not supported in Python3.
Change-Id: Ic7afb3cf2d8dfad47b8a1626ab264f6d4f50d00e
Signed-off-by: Chuck Short <chuck.short@canonical.com>
Resolves: bug 1185142
Implements blueprint: clients-man-pages
Provide basic but hopefully useful man page.
shell.rst was merged into and replaced by the man page in HTML docs.
Change-Id: I0a90e4638cc7e4ed9c02c5abd7d84a4079e5f50d
adding in openstack theming
enabling last update from git
removing old manual references to API, converted entirely to autodoc
updated .gitignore
fixed docstring warnings and errors
Change-Id: Id22ddc446331d52cbf56c3462d8b532fc37f64ac
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: I205e8bb1ddf6dae1d7392b32975319c6a6d98673
