Provide a reference on how to use the extension.
Change-Id: I37716be4ca28fd84b50d1588fe9361a84ff5caec
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
the labels with the project name to help share the label space; for example,
use ``sfc-user-guide`` instead of just ``user-guide``.
+Referencing JIRA issues
+^^^^^^^^^^^^^^^^^^^^^^^
+
+In order to reference JIRA, we provide two new directives, ``jira_fixed_issues`` and
+``jira_known_issues``. These render a table of issues for a particular project and
+its version range. These are used like this:
+
+ .. code-block:: rst
+
+ .. jira_fixed_issues::
+ :project: CONTROLLER
+ :versions: 4.0.0-4.0.3
+
+ .. jira_known_issues::
+ :project: CONTROLLER
+ :versions: 4.0.0-4.0.3
+
.. _docs-rst-troubleshooting:
+++ /dev/null
-Sphinx extensions
-
-TODO: add proper linking