aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorchenxing <chason.chan@foxmail.com>2019-06-14 19:10:25 +0800
committerchenxing <chason.chan@foxmail.com>2019-06-14 21:23:10 +0800
commitae1e2e680867559fb97da869086ccfcfc4cbd62d (patch)
treef114eae126cd0fa3f0ce1bb9ffe2b56de692de39 /doc
parent39a2cf066c4c79436629017155302d36243aa338 (diff)
downloadkolla-ae1e2e680867559fb97da869086ccfcfc4cbd62d.tar.gz
kolla-ae1e2e680867559fb97da869086ccfcfc4cbd62d.zip
doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1]. Note that this doesn't mean the URLs are actually valid - we need to do more work (linkcheck?) here, but it's an improvement nonetheless. [1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt2
-rw-r--r--doc/source/admin/image-building.rst14
-rw-r--r--doc/source/conf.py4
-rw-r--r--doc/source/contributor/CONTRIBUTING.rst6
-rw-r--r--doc/source/contributor/index.rst2
-rw-r--r--doc/source/contributor/running-tests.rst4
6 files changed, 16 insertions, 16 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index ab68d4701..0a525ddbf 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
doc8>=0.6.0 # Apache-2.0
-openstackdocstheme>=1.18.1 # Apache-2.0
+openstackdocstheme>=1.19.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst
index 1f099802b..a0b756c8c 100644
--- a/doc/source/admin/image-building.rst
+++ b/doc/source/admin/image-building.rst
@@ -1,5 +1,3 @@
-.. _image-building:
-
=========================
Building Container Images
=========================
@@ -151,9 +149,8 @@ repository named ``mykollarepo``:
kolla-build -n mykollarepo --push
-To push images to a `local registry
-<https://docs.openstack.org/kolla-ansible/latest/user/multinode.html#deploy-a-registry>`_,
-use ``--registry`` flag:
+To push images to a :kolla-ansible-doc:`local registry
+<user/multinode.html#deploy-a-registry>`, use ``--registry`` flag:
.. code-block:: console
@@ -217,6 +214,8 @@ overrides file, add the following:
RUN subscription-manager register --user=<user-name> \
--password=<password> && subscription-manager attach --pool <pool-id>
+.. _dockerfile-customisation:
+
Dockerfile Customisation
========================
@@ -534,9 +533,8 @@ Kolla-ansible with Local Registry
To make kolla-ansible pull images from a local registry, set
``"docker_registry"`` to ``"172.22.2.81:5000"`` in
``"/etc/kolla/globals.yml"``. Make sure Docker is allowed to pull images from
-insecure registry. See
-`Docker Insecure Registry
-<https://docs.openstack.org/kolla-ansible/latest/user/multinode.html#deploy-a-registry>`_.
+insecure registry. See :kolla-ansible-doc:`Docker Insecure Registry
+<user/multinode.html#deploy-a-registry>`.
Building behind a proxy
-----------------------
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d4a23cab2..862ab85e9 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -88,3 +88,7 @@ latex_documents = [
repository_name = 'openstack/kolla'
bug_project = 'kolla'
bug_tag = ''
+openstack_projects = [
+ 'kolla-ansible',
+ 'oslotest',
+]
diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst
index 3d86d1c06..83632d44d 100644
--- a/doc/source/contributor/CONTRIBUTING.rst
+++ b/doc/source/contributor/CONTRIBUTING.rst
@@ -1,5 +1,3 @@
-.. _CONTRIBUTING:
-
=================
How To Contribute
=================
@@ -77,8 +75,8 @@ multiple processes generally use a base image and child images, for example,
``glance-base``, ``glance-api``, and ``glance-registry``.
Jinja2 'blocks' are employed throughout the Dockerfile's to help operators
-customise various stages of the build (refer to `Dockerfile Customisation
-<https://docs.openstack.org/kolla/latest/admin/image-building.html#dockerfile-customisation>`__)
+customise various stages of the build (refer to :ref:`Dockerfile Customisation
+<dockerfile-customisation>`)
Some of these blocks are free form however, there are a subset that should be
common to every Dockerfile. The overall structure for a multi container service
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
index 44766f0f6..40c5b0d19 100644
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@@ -12,7 +12,7 @@ We welcome everyone to join our project!
.. toctree::
:maxdepth: 2
- CONTRIBUTING.rst
+ CONTRIBUTING
running-tests
bug-triage
ptl-guide
diff --git a/doc/source/contributor/running-tests.rst b/doc/source/contributor/running-tests.rst
index ebd82007c..5d30703be 100644
--- a/doc/source/contributor/running-tests.rst
+++ b/doc/source/contributor/running-tests.rst
@@ -107,8 +107,8 @@ Then run :command:`tox` with the debug environment as one of the following:
tox -e debug
tox -e debug test_file_name.TestClass.test_name
-For more information see the `oslotest documentation
-<https://docs.openstack.org/oslotest/latest/user/features.html#debugging-with-oslo-debug-helper>`_.
+For more information see the :oslotest-doc:`oslotest documentation
+<user/features.html#debugging-with-oslo-debug-helper>`.
.. rubric:: Footnotes