Menu
▾
▴
[Docutils-checkins] SF.net SVN: docutils:[8672] trunk/docutils
|
From: <mi...@us...> - 2021-04-07 12:10:09
|
Revision: 8672
http://sourceforge.net/p/docutils/code/8672
Author: milde
Date: 2021-04-07 12:10:06 +0000 (Wed, 07 Apr 2021)
Log Message:
-----------
Update documentation
rST parser is no longer the only one.
Modified Paths:
--------------
trunk/docutils/docs/user/config.txt
trunk/docutils/docutils/utils/__init__.py
trunk/docutils/docutils/writers/xetex/__init__.py
Modified: trunk/docutils/docs/user/config.txt
===================================================================
--- trunk/docutils/docs/user/config.txt 2021-04-07 12:09:51 UTC (rev 8671)
+++ trunk/docutils/docs/user/config.txt 2021-04-07 12:10:06 UTC (rev 8672)
@@ -466,6 +466,10 @@
Default: None. Option: ``--record-dependencies``.
+.. [#dependencies] Images are only added to the dependency list if they
+ are embedded into the output or the reStructuredText parser extracted
+ image dimensions from the file.
+
report_level
------------
@@ -598,9 +602,47 @@
[parsers]
=========
-Docutils currently supports only one parser, for reStructuredText.
+Generic parser options:
+file_insertion_enabled
+----------------------
+Enable or disable directives or directive that insert the contents of
+external files, such as "include_" or "raw_" with option "url".
+A "warning" system message (including the directive text) is inserted
+instead. (See also raw_enabled_ for another security-relevant setting.)
+
+Default: enabled (True).
+Options: ``--file-insertion-enabled, --no-file-insertion``.
+
+.. _include: ../ref/rst/directives.html#include
+.. _raw: ../ref/rst/directives.html#raw
+
+line_length_limit
+-----------------
+
+Maximal number of characters in an input line or `substitution`_
+definition. To prevent extraordinary high processing times or memory
+usage for certain input constructs, a "warning" system message is
+inserted instead.
+
+Default: 10 000.
+Option: ``--line-length-limit``
+
+New in Docutils 0.17.
+
+.. _substitution: ../ref/rst/directives.html#substitution
+
+raw_enabled
+-----------
+
+Enable or disable the "raw_" directive. A "warning" system message
+(including the directive text) is inserted instead. See also
+file_insertion_enabled_ for another security-relevant setting.
+
+Default: enabled (True). Options: ``--raw-enabled, --no-raw``.
+
+
[restructuredtext parser]
-------------------------
@@ -630,35 +672,6 @@
New in Docutils 0.13.
-file_insertion_enabled
-~~~~~~~~~~~~~~~~~~~~~~
-
-Enable or disable directives that insert the contents of external
-files, such as the "include_" & "raw_". A "warning" system
-message (including the directive text) is inserted instead. (See
-also raw_enabled_ for another security-relevant setting.)
-
-Default: enabled (True).
-Options: ``--file-insertion-enabled, --no-file-insertion``.
-
-.. _include: ../ref/rst/directives.html#include
-.. _raw: ../ref/rst/directives.html#raw
-
-line_length_limit
-~~~~~~~~~~~~~~~~~
-
-Maximal number of characters in an input line or `substitution`_
-definition. To prevent extraordinary high processing times or memory
-usage for certain input constructs, a "warning" system message is
-inserted instead.
-
-Default: 10 000.
-Option: ``--line-length-limit``
-
-New in Docutils 0.17.
-
-.. _substitution: ../ref/rst/directives.html#substitution
-
pep_references
~~~~~~~~~~~~~~
@@ -682,15 +695,6 @@
Default: "pep-%04d". Option: ``--pep-file-url``.
-raw_enabled
-~~~~~~~~~~~
-
-Enable or disable the "raw_" directive. A "warning" system message
-(including the directive text) is inserted instead. See also
-file_insertion_enabled_ for another security-relevant setting.
-
-Default: enabled (True). Options: ``--raw-enabled, --no-raw``.
-
rfc_references
~~~~~~~~~~~~~~
@@ -794,18 +798,23 @@
trim_footnote_reference_space
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Remove spaces before `footnote references`_. [#]_
+Remove spaces before `footnote references`_?
-Default: don't (None) rsp. depending on the writer-specific
-`footnote_references setting`_. [#footnote_space]_
+Default: None [#]_
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".
+.. [#] Depending on the writer-specific `footnote_references setting`_.
+ The footnote space is trimmed if the reference style is "superscript",
+ and it is left if the reference style is "brackets".
+[markdown parser]
+-----------------
+based on recommonmark_
+.. _recommonmark: https://pypi.org/project/recommonmark/
+
[readers]
=========
@@ -985,8 +994,8 @@
Format for `footnote references`_, one of "superscript" or "brackets".
See also `footnote_references [latex writers]`_.
-Overrides [#override]_ trim_footnote_reference_space_, if
-applicable. [#footnote_space]_
+Overrides [#override]_ trim_footnote_reference_space_,
+if the parser supports this option.
Default: "brackets". Option: ``--footnote-references``.
@@ -1501,8 +1510,8 @@
Format for `footnote references`_: one of "superscript" or "brackets".
See also `footnote_references [html writers]`_.
-Overrides [#override]_ trim_footnote_reference_space_, if
-applicable. [#footnote_space]_
+Overrides [#override]_ trim_footnote_reference_space_,
+if the parser supports this option.
Default: "superscript". Option: ``--footnote-references``.
@@ -2128,6 +2137,7 @@
Default: stdin (None). No command-line options.
+--------------------------------------------------------------------------
.. _language tag: http://www.w3.org/International/articles/language-tags/
.. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
@@ -2144,13 +2154,7 @@
do the overriding explicitly, by assigning ``None`` to the other
settings.
-.. [#dependencies] Images are only added to the dependency list if the
- reStructuredText parser extracted image dimensions from the file.
-.. [#footnote_space] The overriding only happens if the parser supports
- the trim_footnote_reference_space option.
-
-
------------------------------
Old-Format Configuration Files
------------------------------
Modified: trunk/docutils/docutils/utils/__init__.py
===================================================================
--- trunk/docutils/docutils/utils/__init__.py 2021-04-07 12:09:51 UTC (rev 8671)
+++ trunk/docutils/docutils/utils/__init__.py 2021-04-07 12:10:06 UTC (rev 8672)
@@ -434,7 +434,7 @@
Runtime settings. If none are provided, a default core set will
be used. If you will use the document object with any Docutils
components, you must provide their default settings as well. For
- example, if parsing, at least provide the parser settings,
+ example, if parsing rST, at least provide the rst-parser settings,
obtainable as follows::
settings = docutils.frontend.OptionParser(
Modified: trunk/docutils/docutils/writers/xetex/__init__.py
===================================================================
--- trunk/docutils/docutils/writers/xetex/__init__.py 2021-04-07 12:09:51 UTC (rev 8671)
+++ trunk/docutils/docutils/writers/xetex/__init__.py 2021-04-07 12:10:06 UTC (rev 8672)
@@ -63,7 +63,7 @@
def __init__(self):
latex2e.Writer.__init__(self)
- self.settings_defaults.update({'fontencoding': ''}) # use default (EU1 or EU2)
+ self.settings_defaults.update({'fontencoding': ''}) # use default (TU)
self.translator_class = XeLaTeXTranslator
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
