summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDolph Mathews <dolph.mathews@gmail.com>2013-06-07 15:33:41 -0500
committerDolph Mathews <dolph.mathews@gmail.com>2013-06-07 15:33:41 -0500
commit8933956f5c7e37d58ef550f26945337bde26833a (patch)
treeb30494c4f95654b6a131820769841a698f208656
parentaa110cf482aace901a39bd9aeaea20f5ad650351 (diff)
downloadkeystone-8933956f5c7e37d58ef550f26945337bde26833a.tar.gz
keystone-8933956f5c7e37d58ef550f26945337bde26833a.tar.xz
keystone-8933956f5c7e37d58ef550f26945337bde26833a.zip
Fix internal doc links (bug 1176211)
Change-Id: Iab416c941c7db00d3fd725e1c0e12ed7fc193dd0
-rw-r--r--doc/source/developing.rst9
-rw-r--r--doc/source/installing.rst14
-rw-r--r--doc/source/middlewarearchitecture.rst3
3 files changed, 9 insertions, 17 deletions
diff --git a/doc/source/developing.rst b/doc/source/developing.rst
index e5751981..b168caf7 100644
--- a/doc/source/developing.rst
+++ b/doc/source/developing.rst
@@ -33,11 +33,8 @@ To contribute tests, docs, code, etc, refer to our `Gerrit-Jenkins-Github Workfl
Setup
-----
-.. _setup: setup.rst
-.. _configuration: configuration.rst
-.. _keystonemanage: man/keystone-manage.rst
-Get your development environment set up according to setup_. The
+Get your development environment set up according to :doc:`setup`. The
instructions from here will assume that you have installed keystone into a
virtualenv. If you chose not to, simply exclude "tools/with_venv.sh" from the
example commands below.
@@ -63,7 +60,7 @@ To run the keystone Admin and API server instances, use::
$ tools/with_venv.sh bin/keystone-all
this runs keystone with the configuration the etc/ directory of the project.
-See configuration_ for details on how Keystone is configured. By default,
+See :doc:`configuration` for details on how Keystone is configured. By default,
keystone is configured with KVS backends, so any data entered into keystone run
in this fashion will not persist across restarts.
@@ -72,7 +69,7 @@ Interacting with Keystone
-------------------------
You can interact with Keystone through the command line using
-keystonemanage_ which allows you to initialize keystone, etc.
+:doc:`man/keystonemanage` which allows you to initialize keystone, etc.
You can also interact with Keystone through its REST API. There is a python
keystone client library `python-keystoneclient`_ which interacts exclusively
diff --git a/doc/source/installing.rst b/doc/source/installing.rst
index 48162153..a7deb91e 100644
--- a/doc/source/installing.rst
+++ b/doc/source/installing.rst
@@ -18,14 +18,10 @@
===================
Installing Keystone
===================
-.. _developing: developing.rst
-.. _setup: setup.rst
-.. _configuration: configuration.rst
-.. _configuring-services: configuringservices.rst
This document describes how to install Keystone in order to use it. If you are
-intending to develop on or with Keystone, please read developing_ and
-setup_.
+intending to develop on or with Keystone, please read :doc:`developing` and
+:doc:`setup`.
Installing from Source
----------------------
@@ -67,7 +63,7 @@ You will find sample configuration files in ``etc/``
* policy.json
* default_catalog.templates
-From here, refer to configuration_ to choose which backend drivers to
+From here, refer to :doc:`configuration` to choose which backend drivers to
enable and use. Once configured, you should be able to run keystone by issuing
the command::
@@ -75,7 +71,7 @@ the command::
which (by default) will show logging on the console from which it was started.
Once started, you can initialize data in keystone for use with the rest of
-openstack, as described in configuring-services_.
+openstack, as described in :doc:`configuringservices`.
An excellent reference implementation of setting up keystone is DEVSTACK_,
most commonly used for development and testing setup of not only Keystone,
@@ -103,7 +99,7 @@ options for setting up and running Keystone. As of this writing, the defaults
for Keystone backends are all SQL based, stored locally in a sqlite.
Once installed, you still need to initialize data in Keystone, which you can
-find described in configuring-services_.
+find described in :doc:`configuringservices`.
Installing from packages: Fedora
--------------------------------
diff --git a/doc/source/middlewarearchitecture.rst b/doc/source/middlewarearchitecture.rst
index b7c5977a..e7704be5 100644
--- a/doc/source/middlewarearchitecture.rst
+++ b/doc/source/middlewarearchitecture.rst
@@ -20,7 +20,6 @@ Middleware Architecture
Abstract
========
-.. _architecture: architecture.rst
The Keystone middleware architecture supports a common authentication protocol
in use between the OpenStack projects. By using keystone as a common
@@ -33,7 +32,7 @@ authentication middleware which acts as the internal API mechanism for
OpenStack projects based on the WSGI standard.
For the architecture of keystone and its services, please see
-architecture_. This documentation primarily describes the implementation
+:doc:`architecture`. This documentation primarily describes the implementation
in ``keystoneclient/middleware/auth_token.py``
(:py:class:`keystoneclient.middleware.auth_token.AuthProtocol`)