Skip to content

Commit

Permalink
doc: Fold lines by 80 columns
Browse files Browse the repository at this point in the history
  • Loading branch information
tk0miya committed May 29, 2019
1 parent 984d2f4 commit d6063ff
Show file tree
Hide file tree
Showing 10 changed files with 149 additions and 115 deletions.
228 changes: 130 additions & 98 deletions CHANGES

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ Debugging Tips
* Set the debugging options in the `Docutils configuration file
<http:https://docutils.sourceforge.net/docs/user/config.html>`_.

* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``) are
generated by this
* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``)
are generated by this
`modified snowballcode generator <https://github.com/shibukawa/snowball>`_.
Generated `JSX <https://jsx.github.io/>`_ files are
in `this repository <https://github.com/shibukawa/snowball-stemmer.jsx>`_.
Expand Down
4 changes: 2 additions & 2 deletions doc/development/tutorials/todo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ We want the extension to add the following to Sphinx:
only shown in the output if a new config value is set. Todo entries should not
be in the output by default.

* A ``todolist`` directive that creates a list of all todo entries throughout the
documentation.
* A ``todolist`` directive that creates a list of all todo entries throughout
the documentation.

For that, we will need to add the following elements to Sphinx:

Expand Down
2 changes: 1 addition & 1 deletion doc/extdev/i18n.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ i18n API
.. _ext-i18n:

Extension internationalization (`i18n`) and localization (`l10n`) using i18n API
---------------------------------------------------------------------------------
--------------------------------------------------------------------------------

.. versionadded:: 1.8

Expand Down
6 changes: 3 additions & 3 deletions doc/extdev/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,9 @@ in which a Sphinx project is built: this works in several phases.

Now that the metadata and cross-reference data of all existing documents is
known, all temporary nodes are replaced by nodes that can be converted into
output using components called transforms. For example, links are created for
object references that exist, and simple literal nodes are created for those
that don't.
output using components called transforms. For example, links are created
for object references that exist, and simple literal nodes are created for
those that don't.

**Phase 4: Writing**

Expand Down
3 changes: 2 additions & 1 deletion doc/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,8 @@ in the future.

The "page name" of the current file, i.e. either the document name if the
file is generated from a reST source, or the equivalent hierarchical name
relative to the output directory (``[directory/]filename_without_extension``).
relative to the output directory
(``[directory/]filename_without_extension``).

.. data:: project

Expand Down
4 changes: 2 additions & 2 deletions doc/usage/extensions/graphviz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ It adds these directives:
``dot`` command within the directive.

.. versionadded:: 1.5
All three directives support a ``align`` option to align the graph horizontal.
The values "left", "center", "right" are allowed.
All three directives support a ``align`` option to align the graph
horizontal. The values "left", "center", "right" are allowed.

.. versionadded:: 1.6
All three directives support a ``name`` option to set the label to graph.
Expand Down
6 changes: 3 additions & 3 deletions doc/usage/extensions/ifconfig.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ This extension is quite simple, and features only one directive:
def setup(app):
app.add_config_value('releaselevel', '', 'env')

The second argument is the default value, the third should always be ``'env'``
for such values (it selects if Sphinx re-reads the documents if the value
changes).
The second argument is the default value, the third should always be
``'env'`` for such values (it selects if Sphinx re-reads the documents if the
value changes).
5 changes: 3 additions & 2 deletions doc/usage/restructuredtext/domains.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1197,8 +1197,9 @@ and template arguments for the prefix of qualified names. For example:
- ``template\<typename TOuter> template\<typename TInner> Wrapper::Outer<TOuter>::Inner``
(:cpp:class:`template\<typename TOuter> template\<typename TInner> Wrapper::Outer<TOuter>::Inner`)

Currently the lookup only succeed if the template parameter identifiers are equal
strings. That is, ``template\<typename UOuter> Wrapper::Outer`` will not work.
Currently the lookup only succeed if the template parameter identifiers are
equal strings. That is, ``template\<typename UOuter> Wrapper::Outer`` will not
work.

As a shorthand notation, if a template parameter list is omitted,
then the lookup will assume either a primary template or a non-template,
Expand Down
2 changes: 1 addition & 1 deletion utils/doclinter.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from typing import List


MAX_LINE_LENGTH = 90
MAX_LINE_LENGTH = 85
LONG_INTERPRETED_TEXT = re.compile(r'^\s*\W*(:(\w+:)+)?`.*`\W*$')
CODE_BLOCK_DIRECTIVE = re.compile(r'^(\s*)\.\. code-block::')
LEADING_SPACES = re.compile(r'^(\s*)')
Expand Down

0 comments on commit d6063ff

Please sign in to comment.