Project Files & Directories

• README.txt: You're reading it.
• COPYING.txt: Public Domain Dedication and copyright details for non-public-domain files (most are PD).
• FAQ.txt: Docutils Frequently Asked Questions.
• HISTORY.txt: Release notes for the current and previous project releases.
• setup.py: Installation script. See "Installation" below.
• install.py: Quick & dirty installation script. Just run it.
• docutils: The project source directory, installed as a Python package.
• extras: Directory for third-party modules that Docutils depends on. These are only installed if they're not already present.
• docs: The project user documentation directory. Contains the following documents:
  • docs/tools.txt: Docutils Front-End Tools
  • docs/latex.txt: Docutils LaTeX Writer
  • docs/rst/quickstart.txt: A ReStructuredText Primer
  • docs/rst/quickref.html: Quick reStructuredText (HTML only)
• licenses: Directory containing copies of license files for non-public-domain files.
• spec: The project specification directory. Contains PEPs (Python Enhancement Proposals), XML DTDs (document type definitions), and other documents. The spec/rst directory contains the reStructuredText specification. The spec/howto directory contains How-To documents for developers.
• tools: Directory for Docutils front-end tools. See docs/tools.txt for documentation.
• test: Unit tests. Not required to use the software, but very useful if you're planning to modify it. See Running the Test Suite below.