summaryrefslogtreecommitdiff
path: root/docutils/FAQ.txt
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-03-10 04:08:38 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-03-10 04:08:38 +0000
commit31e7be7faa8231670d759ded12785dc89d65ca68 (patch)
treee5fba39b8e5bdbface39697edec6c35f059fbf0e /docutils/FAQ.txt
parent426a4d66660df37a20106709c32a9ea72e7031d6 (diff)
downloaddocutils-31e7be7faa8231670d759ded12785dc89d65ca68.tar.gz
expanded "What is Docutils?" answer
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4385 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
Diffstat (limited to 'docutils/FAQ.txt')
-rw-r--r--docutils/FAQ.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/docutils/FAQ.txt b/docutils/FAQ.txt
index 07d8f7dea..2d7ddbe7e 100644
--- a/docutils/FAQ.txt
+++ b/docutils/FAQ.txt
@@ -35,6 +35,15 @@ documentation from Python modules and packages (under development),
`PEPs (Python Enhancement Proposals)`_ (implemented), and others as
discovered.
+The Docutils distribution consists of:
+
+* a library (the "docutils" package), which `can be used by client
+ code`_;
+* several `front-end tools`_ (such as ``rst2html.py``, which converts
+ reStructuredText input into HTML output);
+* a `test suite`_; and
+* extensive documentation_.
+
For an overview of the Docutils project implementation, see `PEP
258`_, "Docutils Design Specification".
@@ -43,6 +52,11 @@ Docutils is implemented in Python_.
.. _Docutils: http://docutils.sourceforge.net/
.. _PEPs (Python Enhancement Proposals):
http://www.python.org/peps/pep-0012.html
+.. _can be used by client code:
+ http://docutils.sourceforge.net/docs/api/publisher.html
+.. _front-end tools: http://docutils.sourceforge.net/docs/user/tools.html
+.. _test suite: http://docutils.sourceforge.net/docs/dev/testing.html
+.. _documentation: http://docutils.sourceforge.net/docs/
.. _PEP 258: http://www.python.org/peps/pep-0258.html
.. _Python: http://www.python.org/
@@ -72,7 +86,8 @@ For more history of reStructuredText and the Docutils project, see `An
Introduction to reStructuredText`_.
Please note that the name is "Docutils", not "DocUtils" or "Doc-Utils"
-or any other variation.
+or any other variation. It is pronounced as in "DOCumentation
+UTILitieS", with emphasis on the first syllable.
.. _An Introduction to reStructuredText:
http://docutils.sourceforge.net/docs/ref/rst/introduction.html