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
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
There were a couple of references to the keystone CLI which doesn't
exist anymore. This was causing warnings when building the docs.
Change-Id: I75714b73884e832e95a62db2b48edf2adc2a0361
currently there is no release history for keystoneclient, though
sometimes the commits are lacking context, this automated approach
is far better than nothing.
Change-Id: Ibb865b4830cbe1e2e99688103d26f1378d2c32b1
Add links to identity service and keystone middleware to
the landing page. This indicates to the user that the
three projects are related.
Change-Id: I37bb4cd866524bad69f90c53e6a58d58202fc263
Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com>
Partial-Bug: #1428321
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Change-Id: I5b4f7bc5268132b129fc56c919af00d7f9600c9f
The auth_token middleware was moved to the keystonemiddleware repo and
the middleware architecture doc was copied there. The copy in the
client repo can be removed.
Change-Id: Ic7b7f970a08746dd4f5d61dd5144c1dae168ad6d
The V3 Client link should come before the V2 Client link if that's
what we want developers to use.
Change-Id: I34a232d21862999a6f1a7acf5382ff752a7e3590
Explain the plugins that are provided and some information on how to
write new ones. This will obviously need to be expanded as more features
are added.
Change-Id: Ie67e93f2ed994c3702ac66e388cf216609dd44ff
Include some client documentation for how to work with a Session object.
This is generally high level with this expectation that a developer
could take the concepts found here and determine more from the module
documentation.
Change-Id: I5e44c1029ce160cb2798cfb8a535aa9f3311799a
The most recent update to releases.rst was made back in 2012,
but it's references in the docs page. It is providing false
(or at least, inaccurate) information. Suggest removing it
since the server side doesn't have a release related file either.
Change-Id: If2a71b55117c450afdade3cad697eba5a626263f
There was no link to the middleware architecture from the main
page so nobody would know that it's there. This adds the link.
Change-Id: I2cd7a458b48d2c2889e4305e01bc013796a67c6e
There were some parts that had invalid RST in their docstrings
which caused warnings and errors to be generated.
Related-Bug: #1278662
Change-Id: Ibb53e6f49b5fa100fa6ecfe47331f9a70729d03b
There was no link from the main page to the v3 client API doc so
there's no easy way to get to it or to know that it's there. This
adds the link.
Change-Id: I3fd49eedcf7b79f6d810ed22cfcffba4ce47dece
Renaming file for consistency, since using-api-v3.rst is being written
there: https://review.openstack.org/#/c/63408
Minor changes have been made to indicate that the file documents the
keystone v2 API.
Change-Id: I694b658a8b59d21615af5d88edc0f7b394ebbe7b
Partial-Bug: #1260527
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
Formally, OpenStack Keystone implements the OpenStack Identity API, and
this is a client to the API, not to Keystone itself.
Change-Id: If568866221a29ba041f0f2cd56dc81deeb9ebc00
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
