summaryrefslogtreecommitdiff
path: root/docutils/docs
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-09-13 10:24:57 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2022-09-13 10:24:57 +0000
commitdca02aabd14a2a5708c5029e56abaf01fe32ce8c (patch)
tree925aef78324fd1d59b12d238f0834b5a67ba2767 /docutils/docs
parent98d22809a35a7224538fff37148ca8943c0baf18 (diff)
downloaddocutils-dca02aabd14a2a5708c5029e56abaf01fe32ce8c.tar.gz
Documentation fixes.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9121 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs')
-rw-r--r--docutils/docs/ref/rst/directives.txt5
-rw-r--r--docutils/docs/ref/rst/mathematics.txt25
-rw-r--r--docutils/docs/user/config.txt13
3 files changed, 25 insertions, 18 deletions
diff --git a/docutils/docs/ref/rst/directives.txt b/docutils/docs/ref/rst/directives.txt
index bc7a2938d..f3d0bd1cf 100644
--- a/docutils/docs/ref/rst/directives.txt
+++ b/docutils/docs/ref/rst/directives.txt
@@ -1518,8 +1518,9 @@ Raw Data Pass-Through
.. WARNING::
The "raw" directive represents a potential security hole. It can
- be disabled with the "raw_enabled_" or "file_insertion_enabled_"
- runtime settings.
+ be disabled with the "raw_enabled_" runtime setting.
+ Insertion of external files can be disabled with the
+ "file_insertion_enabled_" runtime setting.
.. _raw_enabled: ../../user/config.html#raw-enabled
diff --git a/docutils/docs/ref/rst/mathematics.txt b/docutils/docs/ref/rst/mathematics.txt
index 6e8b703cf..d66fd6bf5 100644
--- a/docutils/docs/ref/rst/mathematics.txt
+++ b/docutils/docs/ref/rst/mathematics.txt
@@ -804,17 +804,22 @@ The text may contain math commands wrapped in ``$`` signs, e.g.
.. TODO ignore {}, handle text-mode commands
-.. TODO: ``\mod`` and its relatives
- --------------------------
-
- Commands ``\mod``, ``\bmod``, ``\pmod``, ``\pod`` deal with the special
- spacing conventions of “mod” notation. ``\mod`` and ``\pod`` are
- variants of ``\pmod`` preferred by some authors; ``\mod`` omits the
- parentheses, whereas ``\pod`` omits the “mod” and retains the
- parentheses.
+``\mod`` and its relatives
+--------------------------
- \gcd(n,m\bmod n) ;\quad x\equiv y\pmod b
- ;\quad x\equiv y\mod c ;\quad x\equiv y\pod d
+Commands ``\mod``, ``\bmod``, ``\pmod``, ``\pod`` deal with the special
+spacing conventions of “mod” notation.
+``\mod`` and ``\pod`` are variants of ``\pmod`` preferred by some
+authors; ``\mod`` omits the parentheses, whereas ``\pod`` omits the
+“mod” and retains the parentheses.
+
+TODO:
+ Currently not supported by the "HTML" and "MathML" math_output_
+ options of the HTML writer (cf. `feature-request #93
+ <https://sourceforge.net/p/docutils/feature-requests/93/>`__).
+
+.. \gcd(n,m\bmod n) ;\quad x\equiv y\pmod b
+ ;\quad x\equiv y\mod c ;\quad x\equiv y\pod d
Integrals and sums
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index f6c17ec0b..5ce830d58 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -613,8 +613,9 @@ 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".
+Enable or disable directives inserting the contents of
+external files, such as "include_" directive
+or the "raw_" and "csv-table_" directives with option "url" or "file".
A "warning" system message (including the directive text) is inserted
instead. (See also raw_enabled_ for another security-relevant setting.)
@@ -623,6 +624,7 @@ Options: ``--file-insertion-enabled, --no-file-insertion``.
.. _include: ../ref/rst/directives.html#include
.. _raw: ../ref/rst/directives.html#raw
+.. _csv-table: ../ref/rst/directives.html#csv-table
line_length_limit
-----------------
@@ -1230,10 +1232,10 @@ See also `table_style [latex writers]`_.
The default CSS sylesheets define:
borderless
- No borders around the table.
+ Remove all borders.
align-left, align-center, align-right
- Align the tables
+ Align table as indicated.
The HTML5 stylesheets also define:
@@ -1252,8 +1254,7 @@ In addition, the HTML writers support:
Overridden by the "widths" option of the `table directive`_.
colwidths-grid
- Backwards compatibility setting. Write column widths
- determined from the source to the HTML file.
+ Write column widths determined from the source to the HTML file.
Overridden by the "widths" option of the `table directive`_.
Default: "". Option: ``--table-style``.