Skip to content

Commit

Permalink
Second take on formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jprestop committed Oct 27, 2023
1 parent db6b5a4 commit e8f61ec
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/Contributors_Guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -468,17 +468,19 @@ formatted in the following way:
so that it can be referenced in a different section.

To reference the section with the label name in a different section, use
the `:ref:` role. For example: `:ref:\`label-name\``
the `:ref:` role. For example::

:ref:`label-name`

For example, in the :ref:`running-metplus` section of the METplus User's Guide
under "Example Wrapper Use Case" it states:

* Create a :ref:`user_configuration_file` (named user_system.conf in this example).

The link to "User Configuration File" is an internal link referenced in the
following way in the .rst file:
following way in the .rst file::

| * Create a `:ref:\`user_configuration_file\`` (named user_system.conf in this example).
* Create a :ref:`user_configuration_file` (named user_system.conf in this example).

The syntax for the label name can be seen in the
`systemconfiguration.rst <https://raw.githubusercontent.com/dtcenter/METplus/develop/docs/Users_Guide/systemconfiguration.rst>`_
Expand Down

0 comments on commit e8f61ec

Please sign in to comment.