diff options
| author | Stefan Appelhoff <stefan.appelhoff@mailbox.org> | 2021-01-21 21:59:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-21 15:59:45 -0500 |
| commit | da816b5b4e876dfb24807dfd3c12f0efe6f27cb7 (patch) | |
| tree | 4fcef21f0248823e87def1dba7aef9ce74746c71 | |
| parent | af154f4300dc4fb3b9ff528657e7b4616864c665 (diff) | |
| download | numpydoc-da816b5b4e876dfb24807dfd3c12f0efe6f27cb7.tar.gz | |
DOC: fix erroneous numpydoc_edit_link formatting (#309)
* fix format: add linebreak
* consistent indent
* add deprecation version arg to numpydoc_edit_link
* add blank line after directive
| -rw-r--r-- | doc/install.rst | 42 |
1 files changed, 22 insertions, 20 deletions
diff --git a/doc/install.rst b/doc/install.rst index d80e7a7..6139efe 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -77,26 +77,28 @@ numpydoc_xref_aliases : dict This option depends on the ``numpydoc_xref_param_type`` option being ``True``. numpydoc_xref_ignore : set or ``"all"`` - How to handle terms not in ``numpydoc_xref_aliases`` when - ``numpydoc_xref_aliases=True``. The value can either be a ``set`` - containing terms to ignore, or ``"all"``. In the former case, the set - contains words not to cross-reference. Most likely, these are common words - used in parameter type descriptions that may be confused for - classes of the same name. For example:: - - numpydoc_xref_ignore = {'type', 'optional', 'default'} - - The default is an empty set. - - If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are - ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in - ``:obj:`` roles. - This configuration parameter may be useful if you only want create - cross references for a small number of terms. In this case, including the - desired cross reference mappings in ``numpydoc_xref_aliases`` and setting - ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing - terms to ignore in a set. + How to handle terms not in ``numpydoc_xref_aliases`` when + ``numpydoc_xref_aliases=True``. The value can either be a ``set`` + containing terms to ignore, or ``"all"``. In the former case, the set + contains words not to cross-reference. Most likely, these are common words + used in parameter type descriptions that may be confused for + classes of the same name. For example:: + + numpydoc_xref_ignore = {'type', 'optional', 'default'} + + The default is an empty set. + + If the ``numpydoc_xref_ignore="all"``, then all unrecognized terms are + ignored, i.e. terms not in ``numpydoc_xref_aliases`` are *not* wrapped in + ``:obj:`` roles. + This configuration parameter may be useful if you only want create + cross references for a small number of terms. In this case, including the + desired cross reference mappings in ``numpydoc_xref_aliases`` and setting + ``numpydoc_xref_ignore="all"`` is more convenient than explicitly listing + terms to ignore in a set. numpydoc_edit_link : bool - .. deprecated:: edit your HTML template instead + .. deprecated:: 0.7.0 + + edit your HTML template instead Whether to insert an edit link after docstrings. |