This project is now inactive. All development has been taken over by the Docutils project.
last updated: 2002-04-21
The purpose of the Python Docstring Processing System project is to create a standard, modular tool for extracting inline documentation from Python modules and converting it into useful formats, such as HTML, XML, and TeX.
This project is now inactive. All development has been taken over by the Docutils project.
This project consists of a Python package, “dps”. This contains utility modules and three subpackages, dps.parsers, dps.formatters, and dps.languages. Each of the subpackages will contain further modules or packages implementing individual components.
Good progress is being made with regards to the parser interface. The dps.statemachine module is useful for line-based parsing of input text using regular expressions, and is being used by the reStructuredText input parser.
The final CVS snapshots are available below:
DPS code, tests, and specifications (no user docs yet) Except for a few typos, this is equivalent to the final release package.
reStructuredText code, tests, documentation, and specifications Except for a few typos, this is equivalent to the final release package.
Development has been suspended at this site. All new development is taking place at the Docutils project.
The final project release package (dps-0.4.tar.gz) and past project releases can be downloaded from the project files page. The final reStructuredText package (restructuredtext-0.4.tar.gz) is also required. Anonymous CVS access is available. You can also browse the latest source files (CVS) individually, and read the final README and HISTORY files.
The specification consists of: candidate PEPs (Python Enhancement Proposals), XML DTDs (document type definitions), an XML catalog file, and some notes. All of the specification files are located in the spec directory of the latest project release package (dps-0.4.tar.gz) (which may not be up to date). The up-to-date working documents (from CVS) may be accessed individually below, or from the snapshots above. You can also browse the CVS repository directly.
PEP 256: Docstring Processing System Framework
[PEP 256 in master repository]*
PEP 257: Docstring Conventions
[PEP 257 in master repository]*
PEP 258: DPS Generic Implementation Details
[PEP 258 in master repository]*
* The PEP titles above are links to local working copies, possibly newer than the versions checked in to the master PEP repository.
Input Context Readers:
For standalone input files: dps.readers.standalone
More to be implemented: Python Source, Email, PEP, Wiki, Web Page, FAQ.
Parsers:
There's room for competition! Survival of the fittest? Amicable coexistence? Evolution by cross-pollination? Put your ideas into practice!
Output Format Writers:
Raw XML (corresponding to the DTDs in the spec): built-in.
Pretty-printed pseudo-XML: dps.writers.pprint.
HTML 4.01 (loose) for CSS-1 stylesheets: dps.writers.html.
More to be implemented: other forms of XML (DocBook etc.), HTML 3.2, TeX, plain text, maybe even reStructuredText.
Please help develop one!
Languages:
English: under development.
Parlez-vous français? Sprechen ze Deutsch? Nihongo hanasemasu ka?
This project will only succeed through the combined efforts of many. We're looking for contributions of testing, ideas, code, bug reports, administration, tasty snacks, computer equipment, and large sums of money. If you're interested in participating, please contact the project administrator.
Project Summary page: Bug reports, patches, feature requests, mailing lists, news
Project administrator: David Goodger
Please direct discussions to the Python Documentation Special Interest Group (Doc-SIG): doc-sig@python.org
Page generated using Alex Martelli's YAPTU (Yet Another Python Templating Utility)
Powered by
Hosted by