From fa00458f4f789b30816790b6262221c09d07d42d Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 12 May 2019 17:57:38 +0900 Subject: [PATCH] docs: Fold lines by 80 chars --- doc/develop.rst | 10 ++++++---- doc/extdev/index.rst | 3 ++- doc/extdev/markupapi.rst | 5 +++-- doc/templating.rst | 9 +++++---- doc/usage/restructuredtext/domains.rst | 11 ++++++----- 5 files changed, 22 insertions(+), 16 deletions(-) diff --git a/doc/develop.rst b/doc/develop.rst index d061aae61..3828b709d 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -31,7 +31,8 @@ This is the current list of contributed extensions in that repository: - actdiag: embed activity diagrams by using actdiag_ - adadomain: an extension for Ada support (Sphinx 1.0 needed) - ansi: parse ANSI color sequences inside documents -- argdoc: automatically generate documentation for command-line arguments, descriptions, and help text +- argdoc: automatically generate documentation for command-line arguments, + descriptions and help text - astah: embed diagram by using astah - autoanysrc: Gather reST documentation from any source files - autorun: Execute code in a ``runblock`` directive @@ -64,7 +65,8 @@ This is the current list of contributed extensions in that repository: - imgur: embed Imgur images, albums, and metadata in documents - inlinesyntaxhighlight_: inline syntax highlighting - lassodomain: a domain for documenting Lasso_ source code -- libreoffice: an extension to include any drawing supported by LibreOffice (e.g. odg, vsd, ...) +- libreoffice: an extension to include any drawing supported by LibreOffice + (e.g. odg, vsd, ...) - lilypond: an extension inserting music scripts from Lilypond_ in PNG format - makedomain_: a domain for `GNU Make`_ - matlabdomain: document MATLAB_ code @@ -100,8 +102,8 @@ This is the current list of contributed extensions in that repository: - zopeext: provide an ``autointerface`` directive for using `Zope interfaces`_ -See the :doc:`extension tutorials <../development/tutorials/index>` on getting started with writing your -own extensions. +See the :doc:`extension tutorials <../development/tutorials/index>` on getting +started with writing your own extensions. .. _aafigure: https://launchpad.net/aafigure diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index eac4ded40..c70ca37be 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -97,7 +97,8 @@ extension. These are: The config is available as ``app.config`` or ``env.config``. -To see an example of use of these objects, refer to :doc:`../development/tutorials/index`. +To see an example of use of these objects, refer to +:doc:`../development/tutorials/index`. .. _build-phases: diff --git a/doc/extdev/markupapi.rst b/doc/extdev/markupapi.rst index ffa08cae7..fc25c2327 100644 --- a/doc/extdev/markupapi.rst +++ b/doc/extdev/markupapi.rst @@ -147,5 +147,6 @@ return ``node.children`` from the Directive. .. seealso:: - `Creating directives `_ - HOWTO of the Docutils documentation + `Creating directives`_ HOWTO of the Docutils documentation + +.. _Creating directives: http://docutils.sourceforge.net/docs/howto/rst-directives.html diff --git a/doc/templating.rst b/doc/templating.rst index b3a26c4b1..3790275f5 100644 --- a/doc/templating.rst +++ b/doc/templating.rst @@ -354,8 +354,8 @@ are in HTML form), these variables are also available: .. data:: body - A string containing the content of the page in HTML form as produced by the HTML builder, - before the theme is applied. + A string containing the content of the page in HTML form as produced by the + HTML builder, before the theme is applied. .. data:: display_toc @@ -382,8 +382,9 @@ are in HTML form), these variables are also available: .. data:: page_source_suffix - The suffix of the file that was rendered. Since we support a list of :confval:`source_suffix`, - this will allow you to properly link to the original source file. + The suffix of the file that was rendered. Since we support a list of + :confval:`source_suffix`, this will allow you to properly link to the + original source file. .. data:: parents diff --git a/doc/usage/restructuredtext/domains.rst b/doc/usage/restructuredtext/domains.rst index 10fbf6f6f..6d4eee033 100644 --- a/doc/usage/restructuredtext/domains.rst +++ b/doc/usage/restructuredtext/domains.rst @@ -1079,15 +1079,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```. + 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```. 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\```. - 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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^