summaryrefslogtreecommitdiff
path: root/doc/usage
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-05-13 14:39:01 +0900
committerGitHub <noreply@github.com>2019-05-13 14:39:01 +0900
commit416426dfb7e96bd72cc244c6ebd34b421d9ac471 (patch)
tree92fe6d2b38a73753eeed578ede751f8d74ad79c7 /doc/usage
parent27a9a3b6781a305ede7bde8795b7dd5867eeab61 (diff)
parentfa00458f4f789b30816790b6262221c09d07d42d (diff)
downloadsphinx-git-416426dfb7e96bd72cc244c6ebd34b421d9ac471.tar.gz
Merge pull request #6356 from tk0miya/foldlines
Add utils/doclinter.py; a documenter linter for Sphinx
Diffstat (limited to 'doc/usage')
-rw-r--r--doc/usage/restructuredtext/domains.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst
index 0f93c89d4..8b06bf0e0 100644
--- a/doc/usage/restructuredtext/domains.rst
+++ b/doc/usage/restructuredtext/domains.rst
@@ -1083,15 +1083,16 @@ These roles link to the given declaration types:
.. admonition:: Note on References with Templates Parameters/Arguments
- These roles follow the Sphinx :ref:`xref-syntax` rules. This means care must be
- taken when referencing a (partial) template specialization, e.g. if the link looks like
- this: ``:cpp:class:`MyClass<int>```.
+ These roles follow the Sphinx :ref:`xref-syntax` rules. This means care must
+ be taken when referencing a (partial) template specialization, e.g. if the
+ link looks like this: ``:cpp:class:`MyClass<int>```.
This is interpreted as a link to ``int`` with a title of ``MyClass``.
In this case, escape the opening angle bracket with a backslash,
like this: ``:cpp:class:`MyClass\<int>```.
- When a custom title is not needed it may be useful to use the roles for inline expressions,
- :rst:role:`cpp:expr` and :rst:role:`cpp:texpr`, where angle brackets do not need escaping.
+ When a custom title is not needed it may be useful to use the roles for
+ inline expressions, :rst:role:`cpp:expr` and :rst:role:`cpp:texpr`, where
+ angle brackets do not need escaping.
Declarations without template parameters and template arguments
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^