docs: tidy plugin references

canonical · Jul 17, 2023 · 311b001 · 311b001
1 parent 1c29dd6
commit 311b001
Show file tree

Hide file tree

Showing 10 changed files with 198 additions and 115 deletions.
diff --git a/docs/reference-core18.rst b/docs/reference-core18.rst
@@ -2,7 +2,7 @@ core18
 ======
 
 .. toctree::
-   :hidden:
+   :maxdepth: 1
 
    the-ant-plugin
    the-ament-plugin

diff --git a/docs/reference-core20.rst b/docs/reference-core20.rst
@@ -2,7 +2,7 @@ core20
 ======
 
 .. toctree::
-   :hidden:
+   :maxdepth: 1
 
    the-ant-plugin
    the-autotools-plugin

diff --git a/docs/reference-core22.rst b/docs/reference-core22.rst
@@ -2,7 +2,7 @@ core22
 ======
 
 .. toctree::
-   :hidden:
+   :maxdepth: 1
 
    the-dotnet-plugin
    the-ant-plugin

diff --git a/docs/supported-plugins.rst b/docs/supported-plugins.rst
diff --git a/docs/the-catkin-tools-plugin.rst b/docs/the-catkin-tools-plugin.rst
@@ -15,13 +15,13 @@ For examples, search `GitHub <https://github.com/search?q=path%3Asnapcraft.yaml+
 
 Plugin-specific features and syntax are dependent on which :ref:`base <base-snaps>` is being used, as outlined below:
 
--  `base: core20 <the-catkin-tools-plugin-heading--core20_>`__
--  `base: core18 \| core <the-catkin-tools-plugin-heading--core18_>`__
+-  `base: core20 <the-catkin-tools-plugin-core20_>`__
+-  `base: core18 \| core <the-catkin-tools-plugin-core18_>`__
 
 This plugin uses the common plugin keywords as well as those for “sources”. For more information, see :ref:`Snapcraft parts metadata <snapcraft-parts-metadata>`.
 
 
-.. _the-catkin-tools-plugin-heading--core20:
+.. _the-catkin-tools-plugin-core20:
 
 base: core20
 ~~~~~~~~~~~~
@@ -35,9 +35,9 @@ This plugin enables the following plugin-specific keywords on core20:
 -  **catkin-tools-cmake-args** (list of strings) Arguments to pass to cmake projects.
 
 
-.. _the-catkin-tools-plugin-heading--core18:
+.. _the-catkin-tools-plugin-core18:
 
 base: core|core18
 ~~~~~~~~~~~~~~~~~
 
-This plugin enables core|core18 properties of the `catkin plugin </t/the-catkin-plugin/8644#the-catkin-tools-plugin-heading--core18>`__.
+This plugin enables core|core18 properties of the `catkin plugin </t/the-catkin-plugin/8644#the-catkin-tools-plugin-core18>`__.
diff --git a/docs/the-colcon-plugin.rst b/docs/the-colcon-plugin.rst
@@ -69,7 +69,7 @@ This plugin enables the following plugin-specific keywords on core18:
 -  **colcon-ament-cmake-args** (list of strings) Arguments to pass to ament_cmake packages. Note that any arguments here which match colcon arguments need to be prefixed with a space. This can be done by quoting each argument with a leading space.
 
 Related Information
-===================
+-------------------
 
 See the :ref:`catkin plugin <the-catkin-plugin>` for building ROS 1 parts.
 

diff --git a/docs/the-conda-plugin.rst b/docs/the-conda-plugin.rst
@@ -11,16 +11,16 @@ This plugin uses the common plugin keywords as well as those for “sources”.
 
 Additional features and syntax are dependent on which :ref:`base <base-snaps>` is being used, as outlined below:
 
--  `base: core22 <the-conda-plugin-heading--core22_>`__
--  `base: core20 <the-conda-plugin-heading--core20_>`__
--  `base: core18 \| core <the-conda-plugin-heading--core18_>`__
+-  `base: core22 <the-conda-plugin-core22_>`__
+-  `base: core20 <the-conda-plugin-core20_>`__
+-  `base: core18 \| core <the-conda-plugin-core18_>`__
 
 For examples, search `GitHub <https://github.com/search?q=path%3Asnapcraft.yaml+%22plugin%3A+conda%22&type=Code>`__ for projects already using the plugin.
 
    ⓘ This is a *snapcraft* plugin. See :ref:`Snapcraft plugins <snapcraft-plugins>` and :ref:`Supported plugins <supported-plugins>` for further details on how plugins are used.
 
 
-.. _the-conda-plugin-heading--core22:
+.. _the-conda-plugin-core22:
 
 base: core22
 ~~~~~~~~~~~~
@@ -34,7 +34,7 @@ This plugin uses the following plugin-specific keywords:
 Requires Snapcraft version *7.0+* .
 
 
-.. _the-conda-plugin-heading--core20:
+.. _the-conda-plugin-core20:
 
 base: core20
 ~~~~~~~~~~~~
@@ -48,7 +48,7 @@ This plugin uses the following plugin-specific keywords:
 Requires Snapcraft version *4.6+* .
 
 
-.. _the-conda-plugin-heading--core18:
+.. _the-conda-plugin-core18:
 
 base: core18 \| core
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/the-nodejs-plugin.rst b/docs/the-nodejs-plugin.rst
@@ -16,7 +16,7 @@ The plugin uses *node* to install dependencies from ``package.json``. It also se
 This plugin uses the common plugin keywords as well as those for “sources”. For more information, see :ref:`Snapcraft parts metadata <snapcraft-parts-metadata>`.
 
 
-.. _the-nodejs-plugin-heading--core18:
+.. _the-nodejs-plugin-core18:
 
 base: core18 \| core
 ~~~~~~~~~~~~~~~~~~~~

diff --git a/docs/the-npm-plugin.rst b/docs/the-npm-plugin.rst
@@ -15,15 +15,15 @@ This plugin uses the common plugin keywords as well as those for “sources”.
 
 Plugin-specific features and syntax are dependent on which :ref:`base <base-snaps>` is being used, as outlined below:
 
--  `base: core22 <the-npm-plugin-heading--core22_>`__
--  `base: core20 <the-npm-plugin-heading--core20_>`__
+-  `base: core22 <the-npm-plugin-core22_>`__
+-  `base: core20 <the-npm-plugin-core20_>`__
 
 See `Node applications <https://snapcraft.io/docs/node-apps>`__ for a simple example, or search `GitHub <https://github.com/search?q=path%3Asnapcraft.yaml+%22plugin%3A+npm%22&type=Code>`__ for projects already using the plugin.
 
    ⓘ This is a *snapcraft* plugin. See :ref:`Snapcraft plugins <snapcraft-plugins>` and :ref:`Supported plugins <supported-plugins>` for further details on how plugins are used.
 
 
-.. _the-npm-plugin-heading--core22:
+.. _the-npm-plugin-core22:
 
 base: core22
 ~~~~~~~~~~~~
@@ -37,7 +37,7 @@ This plugin uses the following plugin-specific keyword:
 Requires Snapcraft version *7.0+*.
 
 
-.. _the-npm-plugin-heading--core20:
+.. _the-npm-plugin-core20:
 
 base: core20
 ~~~~~~~~~~~~

diff --git a/docs/the-python-plugin.rst b/docs/the-python-plugin.rst
@@ -14,16 +14,16 @@ This plugin uses the common plugin keywords as well as those for “sources”.
 
 Plugin-specific features and syntax are dependent on which :ref:`base <base-snaps>` is being used, as outlined below:
 
--  `base: core22 <the-python-plugin-heading--core22_>`__
--  `base: core20 <the-python-plugin-heading--core20_>`__
--  `base: core18 \| core <the-python-plugin-heading--core18_>`__
+-  `base: core22 <the-python-plugin-core22_>`__
+-  `base: core20 <the-python-plugin-core20_>`__
+-  `base: core18 \| core <the-python-plugin-core18_>`__
 
 See :ref:`Python applications <python-apps>` for a simple example, or search `GitHub <https://github.com/search?q=path%3Asnapcraft.yaml+%22plugin%3A+python%22&type=Code>`__ for projects already using the plugin.
 
    ⓘ This is a *snapcraft* plugin. See :ref:`Snapcraft plugins <snapcraft-plugins>` and :ref:`Supported plugins <supported-plugins>` for further details on how plugins are used.
 
 
-.. _the-python-plugin-heading--core22:
+.. _the-python-plugin-core22:
 
 base: core22
 ~~~~~~~~~~~~
@@ -49,7 +49,7 @@ Use of python3- in stage-packages will force the inclusion of the python interpr
 Requires Snapcraft version *7.0+*.
 
 
-.. _the-python-plugin-heading--core20:
+.. _the-python-plugin-core20:
 
 base: core20
 ~~~~~~~~~~~~
@@ -75,7 +75,7 @@ Use of python3- in stage-packages will force the inclusion of the python interpr
 Requires Snapcraft version *4.0+*.
 
 
-.. _the-python-plugin-heading--core18:
+.. _the-python-plugin-core18:
 
 base: core18 \| core
 ~~~~~~~~~~~~~~~~~~~~