reStructuredText defines & implement a markup syntax for use in Python docstrings and other documentation domains, that is readable & simple, yet powerful. Project inactive. Development taken over by Docutils, http://docutils.sourceforge.net/.
Be the first to post a text review of reStructuredText. Rate and review a project by clicking thumbs up or thumbs down in the right column.
Development has been transferred to Docutils, http://docutils.sf.net/.
These are the final releases for these projects. Development is transferring to Docutils, http://docutils.sf.net/. http://prdownloads.sf.net/structuredtext/restructuredtext-0.4.tar.gz http://prdownloads.sf.net/docstring/dps-0.4.tar.gz
Release 0.4 (2002-04-18) ======================== This is the final release of reStructuredText as an independent package. Development is being transferred to the Docutils_ project immediately. .. _Docutils: http://docutils.sourceforge.net/ General: updated docstrings for new field list syntax (bibliographic info); changed contact email addresses. * install.py: Added to project. * setup.py: - Modified for import by install.py. - Added 'restructuredtext.languages' subpackage. * COPYING.txt: Added to project. * docs: Subdirectory added. Contains quickref.html by Tony Ibbs and quickstart.txt by Richard Jones. * restructuredtext/__init__.py: - Added docstrings. - Modified Parser.parse() for updated RSTStateMachine and dps.parsers.Parser. - Added form feed & vertical tab conversion to spaces. - Added a ``Parser.statemachine`` instance attribute. - Added parser language module support. - Updated for new root document Node creation protocol. * restructuredtext/states.py: - Added support for enumerated lists (Body.enumerated(), EnumeratedList). - Added new exceptions: ParserError, TransformationError. - Loosened inline markup start-string & end-string patterns. - Added docstrings. - Changed RSTStateMachine.run() to return the document instance. - Extracted checksubsection() and newsubsection() from RSTState.section(). - Added RSTState.nestedparse(). - Fixed bugs with overline-section-header level parsing. - Fixed URI pattern to match absolute paths & news (opaque); only known URI schemes; IPv6 support. - Removed dependency on trailing spaces. - Extracted Body.block_quote() from Body.indent(). - Changed underlines/overlines to require at least 4 characters (avoids '...', '???', etc.). - Factored SpecializedBody out of Body subclasses. - Factored SpecializedText out of Text subclass. - Added support for field lists, option lists. - Changed interpreted text roles to ':role:' syntax, outside of backquotes. - Simplified RSTState.inlineobj(). - Dropped leading '_' from footnotes. - Dropped brackets from footnotes' implicit hyperlink names. - Added check for whitespace in hyperlinks. - Added empty comment support. - Added support for auto-numbered footnotes, auto-symbol footnotes. - Dropped requirement for blank line between definition list items. - Added support for classifier after term in definition list items. - Fixed bugs with literal blocks. - Changed ``element.extend(nodelist)`` to ``element += nodelist``. - Added full table support (Body.table() etc.). - Split off NestedStateMachine (recursive) from RSTStateMachine (entry point). - Changed indentSM to nestedSM where appropriate. - Added language module support. - Changed numbered reporter.system_warning calls to named methods. - Name changes (lowercased, updated, improved). - Integer attributes on elements as appropriate. - Added directive functionality. - Mild refactoring: meaningful variable names, extracted common code to methods. - Removed debug code. - Updated: 'errorist' -> 'reporter'. - Added support for indirect hyperlink targets. - Updated for renamed ``add*link`` -> ``add*target``. - Added inline hyperlink targets. - Added anonymous hyperlinks (``.. __:`` & ``__`` syntax). - External targets' URIs now in "refuri" attribute, not data. - Changed "[hyper]link" to "reference". - Added substitution definitions & substitution references. - Modified ``RSTState.inlineobj()`` to return end-string. - Added support for multi-line label text for hyperlink targets & substitution definitions. - Moved 'normname()' to dps/utils.py. - Updated for languagecode. - Updated for hyperlink, footnote transforms. - Updated for new root document Node creation protocol. - Changed "system_warning" to "system_message". - Removed gratuitous pseudo-default arguments from functions & methods. - Added literal blocks to system messages whenever the erroneous source text was omitted. - Wrapped problematic inline markup in "problematic" elements, added links to & from system messages. - Added ``Body.parse_extension_attributes()``. * restructuredtest/tableparser.py: Added to project. Contains the TableParser class. * restructuredtext/test_states.py: Refactored to test directory. This file removed. * restructuredtext/directives/__init__.py: - Added directive registry. - Added directive module & function import support. * restructuredtext/directives/misc.py: Implementation of a test directive, 'restructuredtext-test-directive'. Added to project. * restructuredtext/directives/admonitions.py: Implementation of admonition directives 'note', 'caution', etc. Added to project. * restructuredtext/directives/components.py: Implementation of document components directives 'contents', 'footnotes', etc. Added to project. * restructuredtext/directives/images.py: Implementation of directives 'image' & 'figure'. Added to project. * restructuredtext/directives/html.py: Implementation of HTML-specific directives 'meta' & 'imagemap'. Added to project. * restructuredtext/languages: Subpackage added to project. Contains modules for language-dependent language-dependent parser features. Includes en.py for English. * test: Subdirectory added. The top-level consists of a modular test framework begun by Garth Kidd. * test/test_states: Subdirectory added; contains test modules refactored from the old restructuredtext/test_states.py. * tools: Subdirectory added. Contains quicktest.py by Garth Kidd, a front-end to the reStructuredText parser; publish.py, a minimal front-end to the Docutils Publisher producing pretty-printed pseudo-XML; and html.py, a simple HTML-producing front-end. * sandbox: Subdirectory added; for playing around. It's OK to make a mess! * sandbox/rtxt2html: Subdirectory added, from files by Remi Bertholet. * sandbox/paulw: Subdirectory added, from files by Paul Wright. * sandbox/alanj: Subdirectory added, from files by Alan Jaffray. * sandbox/richardj: Subdirectory added, from files by Richard Jones. * spec/alternatives.txt: Added to project. * spec/directives.txt: Added to project. * spec/introduction.txt: - Python interpretation of interpreted text is a DPS job. - Converted sf to sourceforge. - Expanded markup purpose. - Updated footnotes. - Removed "Python-specific markup" from implementation plan. - Expanded on the "Unobtrusive" goal. * spec/problems.txt: - Added mention of GvR's backslash escape endorsement. - Removed mention of compound enumerators. - Updated footnotes. - Removed "Parser Implementation Plan". (It's implemented!) - Revised. * spec/reStructuredText.txt: - Modified inline markup prefix & suffix definitions. - Added a note on inline markup & escapes. - Added inline markup recognition order info. - Moved interpreted text's role outside of backquotes. - Changed interpreted text roles to ":role:" syntax. - Settled on field list syntax, updated definition. - Added 'abstract' to list of bibliographic elements. - Removed 'title' and 'subtitle' from the list of bibliographic elements. - Expanded bibliographic field list handling description. - Updated comments, indent/dedent. - Added definition of empty comments. - Loosened enumerated list requirements; clarified Roman numerals & alphabet letters; added syntax diagram. - Removed requirement for blank lines between definition list items. - Added 'classifier' to definition list items. - Added auto-numbered footnotes. - Removed leading underscores from footnote definition; added implicit hyperlink generation. - Updated & expanded definition of directives; added link to new directives.txt. - Added option lists & doctest blocks from pyextensions.txt. - Added VMS/DOS-style options to option lists. - Converted sf->sourceforge. - Expanded definition of whitespace. - Added Reference Names section. - Moved Standalone Hyperlinks section. - Expanded definition of standalone URIs. - Clarified definition of underlines/overlines. - Clarified handling of duplicate explicit hyperlink target names with identical URIs. - Added two escapes where needed. - Added a note about backslashes in other contexts. - Reworked literal block section in a more logical and easy-to-remember way. - Converted footnotes in text to auto-numbered. - Standardized on double-quotes ("). - Changed "indirect hyperlinks" to "external hyperlinks". - Added new "indrect hyperlinks". - Added "anonymous hyperlinks". - Rearranged hyperlink description. - Added "Document Structure" section. - Added "division" construct. - Removed element hierarchy diagram to dps/spec/doctree.txt. - Added inline hyperlink targets. - Changed "hyperlink names" to "reference names", "link" to "reference". - Added substitution definitions, substitution references (use cases contributed by Alan Jaffray). - Added to table description. - Added note about hyperlink/footnote/citation reference name shared namespace. - Added "Auto-Symbol Footnotes", "Mixed Manual and Auto-Numbered Footnotes", and "Citations". * spec/pyextensions.txt: - Removed from project (became DPS spec/python-mode.txt).
Copyright © 2009 Geeknet, Inc. All rights reserved. Terms of Use
Thanks for your rating!
Would you also like to write a review?