summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-01-11 17:40:00 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-01-11 17:40:00 +0000
commit06f0004c54b9079d78860b5aebb3eca1428ee415 (patch)
treecc161eefd2b5576c596603bc9750edcb4dd640ba /docutils/docs/user
parent5f3329d0e04ad82c0770e06fb9272bc43b6a69e6 (diff)
downloaddocutils-06f0004c54b9079d78860b5aebb3eca1428ee415.tar.gz
Refer to the "pycmark" CommonMark parser and other documentation fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8942 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/config.txt46
1 files changed, 33 insertions, 13 deletions
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index bd0a943e4..6a8a203bd 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -348,6 +348,8 @@ The threshold at or above which system messages are converted to
exceptions, halting execution immediately. If `traceback`_ is set, the
exception will propagate; otherwise, Docutils will exit.
+See also report_level_.
+
Default: severe (4). Options: ``--halt, --strict``.
id_prefix
@@ -485,6 +487,8 @@ Report system messages at or higher than <level>:
4 severe
5 none
+See also halt_level_.
+
Default: warning (2).
Options: ``--report, -r, --verbose, -v, --quiet, -q``.
@@ -818,17 +822,6 @@ Options: ``--trim-footnote-reference-space, --leave-footnote-reference-space``.
and it is left if the reference style is "brackets".
-.. _recommonmark:
-
-[recommonmark parser]
----------------------
-
-Experimental, based on recommonmark__.
-Currently no configuration settings.
-
-__ https://pypi.org/project/recommonmark/
-
-
.. _myst:
[myst parser]
@@ -845,6 +838,29 @@ See `MyST with Docutils`_ and its `Sphinx configuration options`_
https://myst-parser.readthedocs.io/en/latest/sphinx/reference.html#sphinx-config-options
+.. _pycmark:
+
+[pycmark parser]
+----------------
+
+Provided by the 3rd party package `pycmark`__.
+Currently no configuration settings.
+
+__ https://pypi.org/project/pycmark/
+
+
+
+.. _recommonmark:
+
+[recommonmark parser]
+---------------------
+
+Provisional, depends on (deprecated) 3rd-party package recommonmark__.
+Currently no configuration settings.
+
+__ https://pypi.org/project/recommonmark/
+
+
[readers]
=========
@@ -2166,8 +2182,10 @@ Option: ``--reader``
parser
~~~~~~
Parser component name.
-One of "rst", "markdown", "recommonmark_", "myst_",
-or the import name of a drop-in parser module.
+Either "rst" (default) or the import name of a drop-in parser module.
+
+Parsers for CommonMark_ known to work with Docutils include "pycmark_",
+"myst_", and "recommonmark_".
Default: "rst".
Option: ``--parser``
@@ -2184,6 +2202,8 @@ or the import name of a drop-in writer module.
Default: "html5".
Option: ``--writer``
+.. _CommonMark: https://spec.commonmark.org/0.30/
+
Other Settings
==============