summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-12-09 04:21:34 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2005-12-09 04:21:34 +0000
commitc2737d5c145b4715cf6ed0b4fd9362e07d50b86b (patch)
treee881a71dd22bb055dfc0d8c2e32fc94e562bb96f /docs
parentd5f4ab3a1f04f05f2212ad316baa6497fb64106f (diff)
downloaddocutils-c2737d5c145b4715cf6ed0b4fd9362e07d50b86b.tar.gz
Converted ``docutils/writers/support/`` into individual writer packages; updated docs & refs.
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@4163 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/distributing.txt2
-rw-r--r--docs/dev/hacking.txt2
-rw-r--r--docs/dev/testing.txt2
-rw-r--r--docs/dev/todo.txt9
-rw-r--r--docs/howto/html-stylesheets.txt2
-rw-r--r--docs/peps/pep-0258.txt22
-rw-r--r--docs/user/config.txt11
-rw-r--r--docs/user/slide-shows.txt2
-rw-r--r--docs/user/tools.txt18
9 files changed, 37 insertions, 33 deletions
diff --git a/docs/dev/distributing.txt b/docs/dev/distributing.txt
index 498a9fa34..c81807279 100644
--- a/docs/dev/distributing.txt
+++ b/docs/dev/distributing.txt
@@ -86,7 +86,7 @@ generate HTML for all documentation files, go to the ``tools/``
directory and run::
# Place html4css1.css in base directory.
- cp ../docutils/writers/support/html4css1.css ..
+ cp ../docutils/writers/html4css1/html4css1.css ..
./buildhtml.py --stylesheet-path=../html4css1.css ..
Then install the following files to ``/usr/share/doc/docutils/`` (or
diff --git a/docs/dev/hacking.txt b/docs/dev/hacking.txt
index dcbc80943..d0ec9a3fb 100644
--- a/docs/dev/hacking.txt
+++ b/docs/dev/hacking.txt
@@ -166,7 +166,7 @@ For HTML output, we can test this using the ``rst2html.py`` tool::
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.10: http://docutils.sourceforge.net/" />
<title></title>
- <link rel="stylesheet" href="../docutils/writers/support/html4css1.css" type="text/css" />
+ <link rel="stylesheet" href="../docutils/writers/html4css1/html4css1.css" type="text/css" />
</head>
<body>
<div class="document">
diff --git a/docs/dev/testing.txt b/docs/dev/testing.txt
index 82e9ed31c..bde54116f 100644
--- a/docs/dev/testing.txt
+++ b/docs/dev/testing.txt
@@ -184,7 +184,7 @@ For example, ``functional/tests/some_test.py`` could read like this::
writer_name = "html"
settings_overrides['output-encoding'] = 'utf-8'
# Relative to main ``test/`` directory.
- settings_overrides['stylesheet_path'] = '../docutils/writers/support/html4css1.css'
+ settings_overrides['stylesheet_path'] = '../docutils/writers/html4css1/html4css1.css'
The two variables ``test_source`` and ``test_destination`` contain the
input file name (relative to ``functional/input/``) and the output
diff --git a/docs/dev/todo.txt b/docs/dev/todo.txt
index 06ce321f1..1074daf33 100644
--- a/docs/dev/todo.txt
+++ b/docs/dev/todo.txt
@@ -1,3 +1,4 @@
+
======================
Docutils_ To Do List
======================
@@ -44,6 +45,9 @@ the short term) to include:
* [DONE in rev. 3901] Move support files to docutils/writers/support.
+* [DONE in rev. 4163] Convert ``docutils/writers/support/*`` into
+ individual writer packages.
+
* [DONE in rev. 3901] Remove docutils.transforms.html.StylesheetCheck
(no longer needed because of the above change).
@@ -52,10 +56,7 @@ the short term) to include:
* [DONE in rev. 4152] Added East-Asian double-width character support.
-* Merge the S5 branch.
-
-* Convert ``docutils/writers/support/*`` to individual writer
- packages.
+* [DONE in rev. 4156] Merge the S5 branch.
Anything else?
diff --git a/docs/howto/html-stylesheets.txt b/docs/howto/html-stylesheets.txt
index 1f61bab5d..9369f2d3c 100644
--- a/docs/howto/html-stylesheets.txt
+++ b/docs/howto/html-stylesheets.txt
@@ -13,7 +13,7 @@
The look of Docutils' HTML output is customizable via a CSS
stylesheet. The default stylesheet is called ``html4css1.css`` and
-can be found in the ``writers/support/`` directory of the Docutils
+can be found in the ``writers/html4css1/`` directory of the Docutils
installation. Use the command ``rst2html.py --help`` and look at the
description of the ``--stylesheet-path`` command-line option for the
exact machine-specific location.
diff --git a/docs/peps/pep-0258.txt b/docs/peps/pep-0258.txt
index 47ede6c21..0d646bb82 100644
--- a/docs/peps/pep-0258.txt
+++ b/docs/peps/pep-0258.txt
@@ -416,12 +416,18 @@ Docutils Package Structure
by name. Class "Writer" is the base class of specific writers.
(``docutils/writers/__init__.py``)
- - Module "docutils.writers.html4css1" is a simple HyperText Markup
- Language document tree writer for HTML 4.01 and CSS1.
+ - Package "docutils.writers.html4css1" is a simple HyperText
+ Markup Language document tree writer for HTML 4.01 and CSS1.
- - Module "docutils.writers.latex2e" writes LaTeX.
+ - Package "docutils.writers.pep_html" generates HTML from
+ reStructuredText PEPs.
- - Module "docutils.writers.newlatex2e" also writes LaTeX; it is a
+ - Package "docutils.writers.s5_html" generates S5/HTML slide
+ shows.
+
+ - Package "docutils.writers.latex2e" writes LaTeX.
+
+ - Package "docutils.writers.newlatex2e" also writes LaTeX; it is a
new implementation.
- Module "docutils.writers.docutils_xml" writes the internal
@@ -438,12 +444,10 @@ Docutils Package Structure
such as DocBook), PDF, plaintext, reStructuredText, and perhaps
others.
- See `Writers`_ above.
+ Subpackages of "docutils.writers" contain modules and data files
+ (such as stylesheets) that support the individual writers.
- - Package "docutils.writers.support": modules and data files that
- support the various writers. The names of subdirectories and
- basenames of files immediately within the support/ directory must
- match the corresponding writer module names.
+ See `Writers`_ above.
- Package "docutils.transforms": tree transform classes.
diff --git a/docs/user/config.txt b/docs/user/config.txt
index 32165c280..c5ec73492 100644
--- a/docs/user/config.txt
+++ b/docs/user/config.txt
@@ -663,9 +663,9 @@ stylesheet_path
setting [#override]_. Path is adjusted relative to the output
HTML file. Also defined for the `LaTeX Writer`__.
- Default: "html4css1.css" in the docutils/writers/support directory
- (installed automatically; for the exact machine-specific path, use
- the ``--help`` option). Options: ``--stylesheet-path``.
+ Default: "html4css1.css" in the docutils/writers/html4css1/
+ directory (installed automatically; for the exact machine-specific
+ path, use the ``--help`` option). Options: ``--stylesheet-path``.
__ `stylesheet_path [latex2e writer]`_
@@ -694,9 +694,8 @@ before the "[pep_html writer]" section.
The PEP/HTML Writer's default for the ``stylesheet_path`` setting
differs from that of the standard HTML Writer:
-``docutils/writers/support/pep_html/pep.css`` in the installation
-directory is used. For the exact machine-specific path, use the
-``--help`` option.
+``docutils/writers/pep_html/pep.css`` in the installation directory is
+used. For the exact machine-specific path, use the ``--help`` option.
_`no_random`
Do not use a random banner image. Mainly used to get predictable
diff --git a/docs/user/slide-shows.txt b/docs/user/slide-shows.txt
index 1fdd8398b..6a0f6655f 100644
--- a/docs/user/slide-shows.txt
+++ b/docs/user/slide-shows.txt
@@ -655,7 +655,7 @@ Making a Custom Theme
* create a personal reusable theme (plugin)
* submit the new theme to Docutils
- ``docutils/writers/support/s5_html/<theme>``
+ ``docutils/writers/s5_html/themes/<theme>``
.. container:: handout
diff --git a/docs/user/tools.txt b/docs/user/tools.txt
index 6f39b5021..20f5a3b2f 100644
--- a/docs/user/tools.txt
+++ b/docs/user/tools.txt
@@ -127,14 +127,14 @@ Stylesheets
``rst2html.py`` inserts into the generated HTML a cascading stylesheet
(or a link to a stylesheet, when passing the "``--link-stylesheet``"
option). A stylesheet is required for proper rendering. The default
-stylesheet (``docutils/writers/support/html4css1.css``, located in the
-installation directory) is provided for basic use. To use a different
-stylesheet, you must specify the stylesheet's location with a
-"``--stylesheet``" (for a URL) or "``--stylesheet-path``" (for a local
-file) command-line option, or with `configuration file`_ settings
-(e.g. ``./docutils.conf`` or ``~/.docutils``). To experiment with
-styles, please see the `guide to writing HTML (CSS) stylesheets for
-Docutils`__.
+stylesheet (``docutils/writers/html4css1/html4css1.css``, located in
+the installation directory) is provided for basic use. To use a
+different stylesheet, you must specify the stylesheet's location with
+a "``--stylesheet``" (for a URL) or "``--stylesheet-path``" (for a
+local file) command-line option, or with `configuration file`_
+settings (e.g. ``./docutils.conf`` or ``~/.docutils``). To experiment
+with styles, please see the `guide to writing HTML (CSS) stylesheets
+for Docutils`__.
__ ../howto/html-stylesheets.html
@@ -150,7 +150,7 @@ rstpep2html.py
reStructuredText) and produces HTML. It requires a template file and
a stylesheet. By default, it makes use of a "``pep-html-template``"
file and the "``pep.css``" stylesheet (both in the
-``docutils/writers/support/`` directory), but these can be overridden
+``docutils/writers/pep_html/`` directory), but these can be overridden
by command-line options or configuration files.
For example, to process a PEP into HTML::
View Lorry Controller Status