summaryrefslogtreecommitdiff
path: root/docutils/docs
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-12-23 14:54:26 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-12-23 14:54:26 +0000
commitf3db6cc68b2edf72015ccb4eccc54cea3b082c5b (patch)
tree3928397a80b8843400d14b2a509b2881b7595241 /docutils/docs
parent7935fbe68da9d9b4278f07b2207d7dae2a915bae (diff)
downloaddocutils-f3db6cc68b2edf72015ccb4eccc54cea3b082c5b.tar.gz
Small documentation updates and fixes.
Also change the priority of the SmartQuotes transform to a level not already in use. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8912 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs')
-rw-r--r--docutils/docs/dev/todo.txt2
-rw-r--r--docutils/docs/ref/transforms.txt6
-rw-r--r--docutils/docs/user/config.txt26
3 files changed, 26 insertions, 8 deletions
diff --git a/docutils/docs/dev/todo.txt b/docutils/docs/dev/todo.txt
index 6f31cc254..c5bd46a98 100644
--- a/docutils/docs/dev/todo.txt
+++ b/docutils/docs/dev/todo.txt
@@ -1563,12 +1563,14 @@ HTML/CSS
* TtH_ (C)
* Hevea_ (Objective Caml)
* `MathJax for Node`_
+ * KaTeX_
__ http://www.cs.tut.fi/~jkorpela/math/
__ http://www.zipcon.net/~swhite/docs/math/math.html
.. _elyxer: http://elyxer.nongnu.org/
.. _TtH: ttp://hutchinson.belmont.ma.us/tth/index.html
.. _Hevea: http://para.inria.fr/~maranget/hevea/
+ .. _KaTeX: https://katex.org
images
(PNG or SVG) like e.g. Wikipedia.
diff --git a/docutils/docs/ref/transforms.txt b/docutils/docs/ref/transforms.txt
index 89401f4a6..9013a7b5c 100644
--- a/docutils/docs/ref/transforms.txt
+++ b/docutils/docs/ref/transforms.txt
@@ -102,15 +102,15 @@ universal.ExposeInternals Reader (r) 840
references.DanglingReferences standalone (r), pep (r) 850
+universal.SmartQuotes Parser 855
+
universal.Messages Writer (w) 860
universal.FilterMessages Writer (w) 870
-universal.SmartQuotes Parser 850
-
universal.TestMessages DocutilsTestSupport 880
-writer_aux.Compound newlatex2e (w) 910
+writer_aux.Compound *not used, to be removed* 910
writer_aux.Admonitions html4css1 (w), 920
latex2e (w)
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index 8aac2c4e9..2d3b67ab2 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -812,13 +812,28 @@ Options: ``--trim-footnote-reference-space, --leave-footnote-reference-space``.
The footnote space is trimmed if the reference style is "superscript",
and it is left if the reference style is "brackets".
-[markdown parser]
------------------
+[recommonmark parser]
+---------------------
Experimental, based on recommonmark_.
+Currently no configuration settings.
.. _recommonmark: https://pypi.org/project/recommonmark/
+[myst parser]
+-------------
+
+Provided by the 3rd party package `myst-docutils`_.
+See `MyST with Docutils`_ and its `Sphinx configuration options`_
+(some settings are not available with Docutils).
+
+.. _myst-docutils: https://pypi.org/project/myst-docutils/
+.. _MyST with Docutils:
+ https://myst-parser.readthedocs.io/en/latest/docutils.html
+.. _Sphinx configuration options:
+ https://myst-parser.readthedocs.io/en/latest/sphinx/reference.html#sphinx-config-options
+
+
[readers]
=========
@@ -954,8 +969,8 @@ Default: don't cloak (None). Option: ``--cloak-email-addresses``.
compact_lists
~~~~~~~~~~~~~
-Remove extra vertical whitespace between items of bullet lists and
-enumerated lists, when list items are all "simple" (i.e., items
+Remove extra vertical whitespace between items of `bullet lists`_ and
+`enumerated lists`_, when list items are all "simple" (i.e., items
each contain one paragraph and/or one "simple" sub-list only). The
behaviour can be specified directly via "class" attributes (values
"compact" and "open") in the document.
@@ -2140,7 +2155,7 @@ Option: ``--reader``
parser
~~~~~~
-Parser component name. One of "markdown", "recommonmark", or "rst"
+Parser component name.
Default: "rst".
Option: ``--parser``
@@ -2272,6 +2287,7 @@ pep_template [pep_html writer] template
../ref/rst/restructuredtext.html#bibliographic-fields
.. _block quote: ../ref/rst/restructuredtext.html#block-quotes
.. _citations: ../ref/rst/restructuredtext.html#citations
+.. _bullet lists: ../ref/rst/restructuredtext.html#bullet-lists
.. _enumerated lists: ../ref/rst/restructuredtext.html#enumerated-lists
.. _field lists: ../ref/rst/restructuredtext.html#field-lists
.. _field names: ../ref/rst/restructuredtext.html#field-names