summaryrefslogtreecommitdiff
path: root/docutils/docs/user
diff options
context:
space:
mode:
authormilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-20 23:47:40 +0000
committermilde <milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2021-03-20 23:47:40 +0000
commit3b21ccdfcff2a7fa6fbaf349fc917f9340b71432 (patch)
tree05b25560609b88416bdb2bdca7300bece9541ef2 /docutils/docs/user
parent4e72975bd141d72b0bd0ee37fc74ce84f0433267 (diff)
downloaddocutils-3b21ccdfcff2a7fa6fbaf349fc917f9340b71432.tar.gz
Documentation update. Warn about file overwriting.
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8640 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/docs/user')
-rw-r--r--docutils/docs/user/config.txt38
-rw-r--r--docutils/docs/user/tools.txt2
2 files changed, 20 insertions, 20 deletions
diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt
index cf4689ecc..3a7c36617 100644
--- a/docutils/docs/user/config.txt
+++ b/docutils/docs/user/config.txt
@@ -58,7 +58,7 @@ Paths are interpreted relative to the current working directory.
Empty path items are ignored.
In addition, a configuration file may be explicitly specified with the
-"--config" command-line option. This configuration file is read after
+``--config`` command-line option. This configuration file is read after
the three implicit ones listed above (or the ones defined by the
``DOCUTILSCONFIG`` environment variable), and its entries will have
priority.
@@ -956,21 +956,6 @@ attributes (values "compact" and "open") in the document.
Default: enabled (True).
Options: ``--compact-field-lists, --no-compact-field-lists``.
-embed_images
-~~~~~~~~~~~~
-
-Embed images in the output HTML file. If the image can be read from
-the local file system and its MIME type can be determined, it is
-base64_ encoded and included as a `data URI`_.
-
-Default: disabled (False).
-Options: ``--embed-images``, ``--link-images``
-
-New in Docutils 0.17.
-
-.. _base64: https://en.wikipedia.org/wiki/Base64
-.. _data URI: https://en.wikipedia.org/wiki/Data_URI_scheme
-
.. _embed_stylesheet [html writers]:
@@ -1305,6 +1290,21 @@ __ https://www.w3.org/TR/html53/sections.html#the-h1-h2-h3-h4-h5-and-h6-element
.. _HTML5: http://www.w3.org/TR/html5/
+embed_images
+""""""""""""
+
+Embed images in the output HTML file. If the image can be read from
+the local file system and its MIME type can be determined, it is
+base64_ encoded and included as a `data URI`_.
+
+Default: disabled (False).
+Options: ``--embed-images``, ``--link-images``
+
+New in Docutils 0.17.
+
+.. _base64: https://en.wikipedia.org/wiki/Base64
+.. _data URI: https://en.wikipedia.org/wiki/Data_URI_scheme
+
[pep_html writer]
~~~~~~~~~~~~~~~~~
@@ -1738,7 +1738,7 @@ use_bibtex
Specify style and database for the experimental `BibTeX` support, for
example::
- --use-bibtex=mystyle,mydb1,mydb2
+ --use-bibtex=mystyle,mydb1,mydb2
Default: "" (don't use BibTeX). Option ``--use-bibtex``.
@@ -1855,8 +1855,8 @@ template__:
"xelatex.tex" in the ``docutils/writers/latex2e/`` directory
(installed automatically).
- .. TODO: show full path with --help (like in the HTML writers) and
- add the following line:
+ .. TODO: show full path with ``--help`` (like in the HTML writers)
+ and add the following line:
for the exact machine-specific path, use the ``--help`` option).
__ `template [latex writers]`_
diff --git a/docutils/docs/user/tools.txt b/docutils/docs/user/tools.txt
index b82f62fb2..2dd27c3f5 100644
--- a/docutils/docs/user/tools.txt
+++ b/docutils/docs/user/tools.txt
@@ -27,7 +27,7 @@ to generate a specific data format).
Most front ends have common options and the same command-line usage
pattern::
- toolname [options] [<source> [<destination]]
+ toolname [options] [<source> [<destination>]]
(The exceptions are buildhtml.py_ and rstpep2html.py_.) See
rst2html.py_ for concrete examples. Each tool has a "``--help``"