From 9e0f6b53bded23e2430388f611de3de94f845bc7 Mon Sep 17 00:00:00 2001 From: milde Date: Wed, 19 Apr 2017 16:47:35 +0000 Subject: [PATCH] Documentation update. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@8059 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- docutils/docs/user/config.txt | 16 +++++++++------- docutils/test/data/dependencies.txt | 8 ++++++++ docutils/test/data/raw.txt | 1 + docutils/test/test_dependencies.py | 2 +- 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/docutils/docs/user/config.txt b/docutils/docs/user/config.txt index 7dfb8867c..2a77b86eb 100644 --- a/docutils/docs/user/config.txt +++ b/docutils/docs/user/config.txt @@ -678,7 +678,8 @@ Default: "http://www.faqs.org/rfcs/". Option: ``--rfc-base-url``. smart_quotes ~~~~~~~~~~~~ -Change straight quotation marks to typographic form. `Quote characters`_ +Activate the SmartQuotes_ transform to +change straight quotation marks to typographic form. `Quote characters`_ are selected according to the language of the current block element (see language_code_). Also changes consequtive runs of hyphen-minus and full stops (``---``, ``--``, ``...``) to em-dash, en-dash and ellipsis Unicode @@ -696,6 +697,7 @@ Default: "no". Option: ``--smart-quotes``. New in Docutils 0.10. +.. _SmartQuotes: smartquotes.html .. _quote characters: http://en.wikipedia.org/wiki/Non-English_usage_of_quotation_marks @@ -786,10 +788,10 @@ The `pep_references`_ and `rfc_references`_ settings (`[restructuredtext parser]`_) are set on by default. -[python reader] ---------------- +.. [python reader] + --------------- -Not implemented. + Not implemented. [writers] @@ -954,7 +956,7 @@ the output document. Supported values are (case insensitive): :HTML: Format math in standard HTML enhanced by CSS rules. Requires the ``math.css`` stylesheet (in the system - `stylesheet directory `_ + `stylesheet directory `_) A `stylesheet_path `_ can be appended after whitespace, the specified @@ -975,8 +977,8 @@ the output document. Supported values are (case insensitive): __ http://docs.mathjax.org/en/latest/tex.html#supported-latex-commands Con: - Requires an Internet connection (or a local MathJax - installation and configuration). + Requires an Internet connection or a local MathJax + installation and configuration. Downloads JavaScript code from a third-party site. diff --git a/docutils/test/data/dependencies.txt b/docutils/test/data/dependencies.txt index cf1660dcd..43eaa8613 100644 --- a/docutils/test/data/dependencies.txt +++ b/docutils/test/data/dependencies.txt @@ -27,3 +27,11 @@ Scaled images without given size are recorded by the html writer: .. image:: ../docs/user/rst/images/biohazard.png :scale: 50 % + +TODO: Paths in included files should be rewritten relative to the base + document. + + * when loading images, + * when recording dependencies. + +.. include: subdir/dependencies-included.txt diff --git a/docutils/test/data/raw.txt b/docutils/test/data/raw.txt index e69de29bb..cfd650974 100644 --- a/docutils/test/data/raw.txt +++ b/docutils/test/data/raw.txt @@ -0,0 +1 @@ +Raw text. diff --git a/docutils/test/test_dependencies.py b/docutils/test/test_dependencies.py index 7fd971c85..8067514d9 100755 --- a/docutils/test/test_dependencies.py +++ b/docutils/test/test_dependencies.py @@ -74,7 +74,7 @@ class RecordDependenciesTests(unittest.TestCase): self.assertEqual(record, expected) def test_dependencies_latex(self): - # since 0.9, the latex writer records only really accessed files, too + # since 0.9, the latex writer records only really accessed files, too. # Note: currently, raw input files are read (and hence recorded) while # parsing even if not used in the chosen output format. # This should change (see parsers/rst/directives/misc.py). -- 2.11.4.GIT