summaryrefslogtreecommitdiff
path: root/doc/usage/restructuredtext
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2019-05-30 10:44:48 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2019-06-01 13:42:57 +0900
commite001d358d0dd83f260ec696e2c14a65bd63cde13 (patch)
treeac28ed763003f0e61f8476dc2b9fef3389d67a6c /doc/usage/restructuredtext
parente9c5e3656fc74c66eb31f897c9f485a10912a2c9 (diff)
downloadsphinx-git-e001d358d0dd83f260ec696e2c14a65bd63cde13.tar.gz
Add :force: option to code directives
Diffstat (limited to 'doc/usage/restructuredtext')
-rw-r--r--doc/usage/restructuredtext/directives.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/usage/restructuredtext/directives.rst b/doc/usage/restructuredtext/directives.rst
index d00979255..1dd9078e8 100644
--- a/doc/usage/restructuredtext/directives.rst
+++ b/doc/usage/restructuredtext/directives.rst
@@ -463,6 +463,12 @@ __ http://pygments.org/docs/lexers/
This will produce line numbers for all code blocks longer than five lines.
+ To ignore minor errors on highlighting, you can specifiy ``:force:`` option.
+
+ .. versionchanged:: 2.1
+
+ ``:force:`` option.
+
.. rst:directive:: .. code-block:: [language]
Example::
@@ -525,6 +531,8 @@ __ http://pygments.org/docs/lexers/
some ruby code
+ A ``force`` option can ignore minor errors on highlighting.
+
.. versionchanged:: 1.1
The ``emphasize-lines`` option has been added.
@@ -538,6 +546,10 @@ __ http://pygments.org/docs/lexers/
.. versionchanged:: 2.0
The ``language`` argument becomes optional.
+ .. versionchanged:: 2.1
+
+ ``:force:`` option has been added.
+
.. rst:directive:: .. literalinclude:: filename
Longer displays of verbatim text may be included by storing the example text
@@ -630,6 +642,8 @@ __ http://pygments.org/docs/lexers/
This shows the diff between ``example.py`` and ``example.py.orig`` with
unified diff format.
+ A ``force`` option can ignore minor errors on highlighting.
+
.. versionchanged:: 0.4.3
Added the ``encoding`` option.
@@ -651,6 +665,9 @@ __ http://pygments.org/docs/lexers/
With both ``start-after`` and ``lines`` in use, the first line as per
``start-after`` is considered to be with line number ``1`` for ``lines``.
+ .. versionchanged:: 2.1
+ Added the ``force`` option.
+
.. _glossary-directive:
Glossary