summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-12-09 00:56:26 +0000
committergoodger <goodger@929543f6-e4f2-0310-98a6-ba3bd3dd1d04>2006-12-09 00:56:26 +0000
commit881629c2b094c287890683ebef32b3ed08aaa2c6 (patch)
treec0ee8d07e4786eda864f0a024d55117b21b5a0ba
parent29ef8b6539cfc9cc22ecac7688a737dc87f51dfa (diff)
downloaddocutils-881629c2b094c287890683ebef32b3ed08aaa2c6.tar.gz
added example config file
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk/docutils@4823 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
-rw-r--r--docs/user/config.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/user/config.txt b/docs/user/config.txt
index 0502ff3a4..d67e4c95a 100644
--- a/docs/user/config.txt
+++ b/docs/user/config.txt
@@ -93,6 +93,29 @@ recognized:
* Off: "false", "no", "off", "0", "" (no value)
+Example
+=======
+
+This is the contents of the ``tools/docutils.conf`` configuration file
+supplied with Docutils::
+
+ # These entries affect all processing:
+ [general]
+ source-link: yes
+ datestamp: %Y-%m-%d %H:%M UTC
+ generator: on
+
+ # These entries affect HTML output:
+ [html4css1 writer]
+ # Required for docutils-update, the website build system:
+ stylesheet-path: ../docutils/writers/html4css1/html4css1.css
+ embed-stylesheet: no
+ field-name-limit: 20
+
+Individual configuration sections and settings are described in the
+following section.
+
+
-------------------------------------
Configuration File Sections & Entries
-------------------------------------