Skip to content

Commit

Permalink
adjust label ref syntax (#1057)
Browse files Browse the repository at this point in the history
hyperlinks for anchors need the `:ref:` directive and do not used the
`_` required for direct URL links.

See: [docs for
anchors](https://docs.open-mpi.org/en/v5.0.x/developers/rst-for-markdown-expats.html#hyperlinks-to-anchors)
  • Loading branch information
erickgalinkin authored Jan 5, 2025
2 parents 8a3b1cf + 4cd6a15 commit ec7e444
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/configurable.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ such as ``show_100_pass_modules``.
* ``probes`` - Root note for probe plugin configs

For an example of how to use the ``detectors``, ``generators``, ``buffs``,
``harnesses``, and ``probes`` root entries, see `Configuring plugins with YAML <config_with_yaml>`_ below.
``harnesses``, and ``probes`` root entries, see :ref:`Configuring plugins with YAML <config_with_yaml>` below.

``reporting`` config items
""""""""""""""""""""""""""
Expand Down Expand Up @@ -176,7 +176,7 @@ has the same structure as a YAML config, starting with the plugin model/type.
The config can either be written to a file and the path passed, with
`--generator_option_file` or `--probe_option_file`, or directly as JSON on the
command prompt, with `--generator_options` or `--probe_options`. An example
is given in `RestGenerator Config with JSON <rest_generator_with_json>`_ below.
is given in :ref:`RestGenerator Config with JSON <rest_generator_with_json>` below.


Configuring Plugins
Expand Down

0 comments on commit ec7e444

Please sign in to comment.