diff options
author | manchandavishal <manchandavishal143@gmail.com> | 2022-01-19 19:50:48 +0530 |
---|---|---|
committer | manchandavishal <manchandavishal143@gmail.com> | 2022-01-21 11:42:14 +0530 |
commit | 83f864f490d9e7dbbc90bf14893c364de9311349 (patch) | |
tree | 40d366188ed62c02112ca8335fe41a49ce263709 | |
parent | 15e3252910d45821a1f84622d54b946ab9127097 (diff) | |
download | horizon-83f864f490d9e7dbbc90bf14893c364de9311349.tar.gz |
Fix hardcoded link error in sphinx 4.4.0
horizon doc job is failing because sphinx 4.4.0 raiseĀ anĀ error
for the hardcoded extlinks link [1]. This patch fixes those links
to unblock the doc gate job.
Closes-Bug: #1958290
Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
[1] https://github.com/sphinx-doc/sphinx/pull/9800
Change-Id: Ica1a16522421a697efdab882afe6d9c08ff05e0b
-rw-r--r-- | doc/source/configuration/settings.rst | 18 | ||||
-rw-r--r-- | doc/source/contributor/contributing.rst | 8 | ||||
-rw-r--r-- | doc/source/contributor/policies/horizon-bugs.rst | 5 | ||||
-rw-r--r-- | doc/source/contributor/quickstart.rst | 2 | ||||
-rw-r--r-- | doc/source/contributor/testing.rst | 2 | ||||
-rw-r--r-- | doc/source/contributor/topics/code-style.rst | 26 | ||||
-rw-r--r-- | doc/source/contributor/tutorials/dashboard.rst | 3 | ||||
-rw-r--r-- | doc/source/contributor/tutorials/table_actions.rst | 3 | ||||
-rw-r--r-- | doc/source/install/from-source.rst | 2 |
9 files changed, 35 insertions, 34 deletions
diff --git a/doc/source/configuration/settings.rst b/doc/source/configuration/settings.rst index ebad4967d..ca029f6fe 100644 --- a/doc/source/configuration/settings.rst +++ b/doc/source/configuration/settings.rst @@ -544,12 +544,12 @@ A template name for a custom user's ``clouds.yaml`` file. If the default template is not suitable for your deployment, you can provide your own clouds.yaml by specifying this setting. -The default template is defined as `clouds.yaml.template -<https://opendev.org/openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/templates/api_access/clouds.yaml.template>`__ +The default template is defined as :opendev-repo:`clouds.yaml.template +<openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/templates/api_access/clouds.yaml.template>` and available context parameters are found in ``_get_openrc_credentials()`` and ``download_clouds_yaml_file()`` functions in -`openstack_dashboard/dashboards/project/api_access/views.py -<https://opendev.org/openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/views.py>`__. +:opendev-repo:`openstack_dashboard/dashboards/project/api_access/views.py +<openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/views.py>` .. note:: @@ -621,12 +621,12 @@ for example, if your deployment uses saml2, openid and so on for authentication, the default ``openrc`` would not be sufficient. You can provide your own clouds.yaml by specifying this setting. -The default template is defined as `openrc.sh.template -<https://opendev.org/openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/templates/api_access/openrc.sh.template>`__ +The default template is defined as :opendev-repo:`openrc.sh.template +<openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/templates/api_access/openrc.sh.template>` and available context parameters are found in ``_get_openrc_credentials()`` and ``download_rc_file()`` functions in -`openstack_dashboard/dashboards/project/api_access/views.py -<https://opendev.org/openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/views.py>`__. +:opendev-repo:`openstack_dashboard/dashboards/project/api_access/views.py +<openstack/horizon/src/branch/master/openstack_dashboard/dashboards/project/api_access/views.py>` .. note:: @@ -2377,7 +2377,7 @@ from neutron when retrieving a list of servers from nova. On the other hand, this operation requires a full list of neutron ports and can potentially lead to a performance issue in large deployments -(`bug 1722417 <https://bugs.launchpad.net/horizon/+bug/1722417>`__). +(:launchpad:`bug 1722417<horizon/+bug/1722417>`). This issue can be avoided by skipping querying IP addresses to neutron and setting this to ``False`` achieves this. Note that when disabling the query to neutron it takes some time until diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 552c106ee..e11726f84 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -14,10 +14,10 @@ with horizon. Project Resources ----------------- -* Source code: https://opendev.org/openstack/horizon +* Source code: :opendev-repo:`openstack/horizon` * Documentation: https://docs.openstack.org/horizon/latest/ * Project page: https://launchpad.net/horizon -* Bug tracker: https://bugs.launchpad.net/horizon +* Bug tracker: :Launchpad:`horizon` * Code review: https://review.opendev.org/#/q/project:openstack/horizon+status:open Communication @@ -86,7 +86,7 @@ Implementing such would be appreciated even if it is small. Task Tracking ------------- -We track our tasks in `Launchpad <https://bugs.launchpad.net/horizon>`__. +We track our tasks in :Launchpad:`horizon`. If you're looking for some smaller, please look through the list of bugs and find what you think you can work on. If you are not sure the status of @@ -98,7 +98,7 @@ Reporting a Bug --------------- You found an issue and want to make sure we are aware of it? -You can do so on `Launchpad <https://bugs.launchpad.net/horizon>`__. +You can do so on :Launchpad:`horizon`. Please file a bug first even if you already have a fix for it. If you can reproduce the bug reliably and identify its cause diff --git a/doc/source/contributor/policies/horizon-bugs.rst b/doc/source/contributor/policies/horizon-bugs.rst index febd31c2a..8d198acad 100644 --- a/doc/source/contributor/policies/horizon-bugs.rst +++ b/doc/source/contributor/policies/horizon-bugs.rst @@ -2,8 +2,7 @@ Horizon Bugs ============ -Horizon project maintains all bugs in -`Launchpad horizon <https://bugs.launchpad.net/horizon>`__. +Horizon project maintains all bugs in :Launchpad:`horizon`. Bug Tags -------- @@ -53,7 +52,7 @@ To check incoming bugs, you can check Launchpad bug page directly, but at the moment the easiest way is to subscribe Launchpad bug mails. The steps to subscribe to the Launchpad bugs are as follows: -* Go to the `horizon bugs page <https://bugs.launchpad.net/horizon>`__. +* Go to the :Launchpad:`horizon bugs page</horizon>`. * On the right hand side, click on "Subscribe to bug mail". * In the pop-up that is displayed, keep the recipient as "Yourself", and set the subscription name to something useful like "horizon-bugs". diff --git a/doc/source/contributor/quickstart.rst b/doc/source/contributor/quickstart.rst index c3e52a10f..6b3ec5065 100644 --- a/doc/source/contributor/quickstart.rst +++ b/doc/source/contributor/quickstart.rst @@ -37,7 +37,7 @@ Setup ===== To begin setting up a Horizon development environment simply clone the Horizon -git repository from https://opendev.org/openstack/horizon +git repository from :opendev-repo:`openstack/horizon`. .. code-block:: console diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index dabd53714..174919a38 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -84,7 +84,7 @@ with Python 3.7 environment. Check ``requirements.txt`` in horizon repository to know which version of Django is actually used. All other dependencies are as defined by the upper-constraints file at -https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt +:opendev-repo:`openstack/requirements/raw/branch/master/upper-constraints.txt`. You can run a subset of the tests by passing the test path as an argument to tox:: diff --git a/doc/source/contributor/topics/code-style.rst b/doc/source/contributor/topics/code-style.rst index 676083f09..10e93d84a 100644 --- a/doc/source/contributor/topics/code-style.rst +++ b/doc/source/contributor/topics/code-style.rst @@ -299,10 +299,13 @@ To make a new release of the package, you need to: `xstatic/pkg/<package name>/__init__.py` file is up to date, especially the `BUILD`. 2. Push your updated package up for review in gerrit. -3. Once the review is approved and the change merged, `request a release`_ by - updating or creating the appropriate file for the xstatic package - in the `releases repository`_ under `deliverables/_independent`. That - will cause it to be automatically packaged and released to PyPi. +3. Once the review is approved and the change merged, + :opendev-repo:`request a release + <openstack/releases/src/branch/master/README.rst>` + by updating or creating the appropriate file for the xstatic package + in the :opendev-repo:`releases repository<openstack/releases>` under + `deliverables/_independent`. + That will cause it to be automatically packaged and released to PyPi. .. warning:: @@ -317,8 +320,6 @@ To make a new release of the package, you need to: .. _documentation: https://xstatic.readthedocs.io/en/latest/packaging.html .. _xstatic-release: https://pypi.org/project/xstatic-release/ .. _`Create a new repository under OpenStack`: https://docs.openstack.org/infra/manual/creators.html -.. _`request a release`: https://opendev.org/openstack/releases/src/branch/master/README.rst -.. _`releases repository`: https://opendev.org/openstack/releases .. _`Set up PyPi`: https://docs.openstack.org/infra/manual/creators.html#give-openstack-permission-to-publish-releases .. _global-requirements: https://github.com/openstack/requirements/blob/master/global-requirements.txt @@ -328,14 +329,18 @@ Integrating a new xstatic package into Horizon Having done a release of an xstatic package: -1. Look for the `upper-constraints.txt`_ edit related to the xstatic release - that was just performed. One will be created automatically by the release +1. Look for the + :opendev-repo:`upper-constraints.txt + <openstack/requirements/raw/branch/master/upper-constraints.txt>` + edit related to the xstatic release that was just performed. + One will be created automatically by the release process in the ``openstack/requirements`` project with the topic `new-release`_. You should -1 that patch until you are confident Horizon does not break (or you have generated a patch to fix Horizon for that release.) If no upper-constraints.txt patch is automatically generated, - ensure the releases yaml file created in the `releases repository`_ has the - "include-pypi-link: yes" setting. + ensure the releases yaml file created in the + :opendev-repo:`releases repository<openstack/releases>` + has the "include-pypi-link: yes" setting. 2. Pull that patch down so you have the edited upper-constraints.txt file locally. 3. Set the environment variable `TOX_CONSTRAINTS_FILE` to the edited @@ -364,7 +369,6 @@ xstatic release: upper-constraints version so that deployers / packagers who don't honor upper-constraints still get compatible versions of the packages. -.. _upper-constraints.txt: https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt .. _new-release: https://review.opendev.org/#/q/status:open+project:openstack/requirements+branch:master+topic:new-release diff --git a/doc/source/contributor/tutorials/dashboard.rst b/doc/source/contributor/tutorials/dashboard.rst index 2b9753783..f61e95c3d 100644 --- a/doc/source/contributor/tutorials/dashboard.rst +++ b/doc/source/contributor/tutorials/dashboard.rst @@ -588,5 +588,4 @@ What you've learned here is the fundamentals of how to write interfaces for your own project based on the components horizon provides. If you have feedback on how this tutorial could be improved, please feel free -to submit a bug against ``Horizon`` in -`launchpad <https://bugs.launchpad.net/horizon>`__. +to submit a bug against :Launchpad:`horizon`. diff --git a/doc/source/contributor/tutorials/table_actions.rst b/doc/source/contributor/tutorials/table_actions.rst index ce8aee4ea..26b88e050 100644 --- a/doc/source/contributor/tutorials/table_actions.rst +++ b/doc/source/contributor/tutorials/table_actions.rst @@ -298,5 +298,4 @@ snapshot to other API calls that require more complex forms to gather the necessary information. If you have feedback on how this tutorial could be improved, please feel free -to submit a bug against ``Horizon`` in -`launchpad <https://bugs.launchpad.net/horizon>`__. +to submit a bug against :Launchpad:`horizon`. diff --git a/doc/source/install/from-source.rst b/doc/source/install/from-source.rst index 94f09f1e6..7e1766317 100644 --- a/doc/source/install/from-source.rst +++ b/doc/source/install/from-source.rst @@ -187,7 +187,7 @@ Deployment For apache2 web server, you may need to create ``/etc/apache2/sites-available/horizon.conf``. The template in DevStack is a good example of the file. - https://opendev.org/openstack/devstack/src/branch/master/files/apache-horizon.template + :opendev-repo:`openstack/devstack/src/branch/master/files/apache-horizon.template`. Or you can automatically generate an apache configuration file. If you previously generated an ``openstack_dashboard/horizon_wsgi.py`` file it will use that, otherwise will default to using ``openstack_dashboard/wsgi.py`` |