Commit Graph

14 Commits

Author SHA1 Message Date
Zuul 64b5e9e882 Merge "Don't rely on pbr ChangeLog for docs" 2018-06-06 20:26:20 +00:00
wangxiyuan 0b7d9ae9b4 Fix the title in index.rst
The titles in the index.rst can't be shown in the webpage.
This patch adds them back.

Change-Id: I56febf6cb137b7f6dbc05365d48159be36d18c13
2018-05-25 11:37:57 +08:00
Colleen Murphy bcdec1acfa Don't rely on pbr ChangeLog for docs
The ChangeLog file is generated when we run `python setup.py sdist`,
which doesn't naturally happen when we run `tox -edocs`, so on a fresh
clone the docs build will fail because it references the ChangeLog file
which isn't there. Since we don't rely on pbr any more for release notes
and we have a sophisticated release note management tool, point the docs
at the published release notes instead of the pbr ChangeLog.

Change-Id: I614091eae739154337795a8f120b68686ad0ed0a
2018-05-24 13:38:52 -07:00
Hangdong Zhang 4a72cd6c3b Update URLs in documentation
Update URLs according to OpenStack document migration.

Change-Id: Icb4232fcce79bb1ea121489122e578e3109b5e90
2017-07-20 16:38:16 +08:00
Eric Brown 96dac98364 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: I8521461203fe40e4576f4de7cfb500bd64027d6d
2017-02-05 20:36:42 -08:00
Steve Martinelli 1d930a281f clean up a few doc building warnings
Fixed two warnings:

  - keystonemiddleware/auth_token/__init__.py:docstring of
    keystonemiddleware.auth_token.BaseAuthProtocol.kwargs_to_fetch_token
    WARNING: Inline strong start-string without end-string.

  - keystonemiddleware/doc/source/api/modules.rst
    WARNING: document isn't included in any toctree

Change-Id: Iaec9adb228fe9131365ab1c15d4c85567921ccdd
2016-12-15 13:42:14 +00:00
Steve Martinelli ef29dfce89 Use extras for oslo.messaging dependency
Install the oslo.messaging optional dependency by doing:

  keystonemiddleware[audit_notifications]

pbr documentation:

  http://docs.openstack.org/developer/pbr/#environment-markers

Partial-Bug: 1540115

Change-Id: I59eea1f7eb0e770ac4fe30211eff49ae76fb2550
2016-06-28 23:56:47 +00:00
Brad Pokorny 05a20bbc95 Update documentation for running tests
The documentation for how to run tests currently says to use
"python setup.py test", which results in errors. Update the docs
to specify tox.

Change-Id: Ib32f6c0708de9439b6bdee4a4fb56cb88bc47d5a
Closes-Bug: #1550068
2016-02-25 16:57:18 -08:00
Steve Martinelli 88547b5151 auto-generate release history
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: I5a10c32ec21b52ee905cbb1f5c52db807a7b2c5b
2015-09-25 00:23:10 -04:00
Dave Chen 71fc24e325 Crosslink to other sites that are owned by Keystone
Add links to identity service and keystoneclient to the
landing page. This indicates to the user that the three
projects are related.

Change-Id: Ibc071f461e0ecf6419438d58afa38de6399061a6
Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com>
Partial-Bug: #1428321
2015-03-14 18:45:56 +08:00
Jenkins 57d787f25b Merge "Workflow documentation is now in infra-manual" 2014-12-31 15:33:23 +00:00
gordon chung bd07f84ed8 documentation for audit middleware
this moves (and edits) audit middleware documentation from pycadf
library to keystonemiddleware

pycadf doc: https://github.com/openstack/pycadf/blob/master/doc/source/middleware.rst

Implements: blueprint audit-middleware
Change-Id: I068f312d8927010fd209eab5c22910c4d1d343a1
2014-12-15 16:44:29 -05:00
Jeremy Stanley 4c0f5f922c Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: I1749faad555c1c42b35935e355247ed876f75907
2014-12-05 03:30:37 +00:00
Morgan Fainberg 07a6d14919 Correct Doc location and update for middleware only
Correct the location of the documents and only publish middleware
documentation.
2014-06-19 21:37:46 -07:00