21 Commits

Author SHA1 Message Date
Boris Bobrov
0a79acf82f Change locations of docs for intersphinx
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
2017-07-05 12:01:10 +03:00
Eric Brown
689729fa35 Use https for *.openstack.org references
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
2017-02-05 20:46:32 -08:00
ji-xuepeng
6632abf191 Removes unnecessary utf-8 encoding
Change-Id: Ide4cb14246394522e35929cf08978aaf5fa9eb59
2017-01-13 21:25:15 +08:00
Corey Bryant
9bc94cc048 import warnings in doc/source/conf.py
Change-Id: If14c02e156f7fe6884ad8de4b80869b2d01de4d7
Closes-Bug: 1587625
2016-05-31 15:48:31 -04:00
Ivan Udovichenko
641aa0f91e Fallback if Git repository is absent
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
2016-04-27 16:45:07 +03:00
Steve Martinelli
ef13bd8cf6 remove CLI from keystoneclient
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
2016-03-10 03:51:01 +00:00
Yatin Kumbhare
13ade585c6 Fix for the deprecated library function
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.

Change-Id: I53c21d6e8a9d23646c236ae33d652f1aefc20153
Closes-Bug: #1529836
2016-01-05 23:00:38 +05:30
Jamie Lennox
bdd44d3142 Map keystoneclient exceptions to keystoneauth
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
2015-11-19 13:35:18 +11:00
David Stanek
4034366b51 Fixes modules index generated by Sphinx
Sphinx was always using (k)eystoneclient for the prefix so the index
wasn't very useful.

Change-Id: I9f883e1005874b5f5019f9030b94174a2169ed77
2015-07-08 20:12:31 +00:00
David Stanek
045e47938f Removes temporary fix for doc generation
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
2015-05-07 03:12:18 +00:00
Jamie Lennox
a15dd80dd2 Fix up types within API documentation
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
2014-12-16 11:36:14 +10:00
Andreas Jaeger
010b06b7c1 Stop using intersphinx
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
2014-09-13 09:43:00 +02:00
Jamie Lennox
bb53808221 Remove intersphinx mappings
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
2014-08-07 15:50:08 +10:00
Steve Martinelli
adcbb3f4db Use oslosphinx to generate doc theme
Since oslosphinx is out, let's use it instead of hosting our own
themes and static files.

Change-Id: I5b507d35c90d0c0411d7751935b0e53328ca9311
2014-07-24 21:43:37 -04:00
Brant Knudson
fd59d02e93 Generate module docs
The module docs were not being generated.

Co-Authored-By: David Stanek <dstanek@dstanek.com>

Change-Id: I26e1d9a3d407474eb6b016f3ada4c495b5043460
Closes-Bug: #1278662
2014-03-13 19:31:21 -05:00
Eric Guo
252b6e423d Adjust import items according to hacking import rule
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
2014-01-17 23:21:38 +08:00
Chuck Short
c27800ee78 python3: Use from future import unicode_literals
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>
2013-08-30 02:41:49 +00:00
Jakub Ruzicka
4f421386e1 Provide keystone CLI man page.
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
2013-06-13 20:49:36 +02:00
Joe Heck
0d48d1b6ce updating keystoneclient doc theme
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
2012-10-01 17:47:34 +00:00
lrqrun
de8622cd8e Fix PEP8 issues.
Fix some pep8 issues in doc/source/conf.py make the code looks pretty.

Change-Id: Ib1e2f8214ad7f4bc49c8c3dfa016843f8df15fe6
2012-08-29 13:55:32 +08:00
Clark Boylan
3ba7738323 Move docs to doc.
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
2012-06-11 13:33:02 -07:00