5 :Author: David Goodger; open to all Docutils developers
6 :Contact: goodger@python.org
8 :Web site: http://docutils.sourceforge.net/
9 :Copyright: This document has been placed in the public domain.
19 - Updated the project policies for trunk/branch development &
22 * setup.py: Added installation of data files in
23 ``docutils/parsers/rst/include/``.
25 * docutils/__init__.py:
27 - Added ``__version_details__`` attribute to describe code source
28 (repository/snapshot/release).
29 - Replaced ``default_transforms`` attribute of TransformSpec with
30 ``get_transforms()`` method.
34 - Added ``publish_doctree`` and ``publish_from_doctree`` convenience
35 functions, for document tree extraction and reprocessing.
39 - Added ``DocTreeInput`` class, for reprocessing existing documents.
40 - Added support for non-Unicode (e.g. binary) writer output.
44 - Added ``serial_escape`` function; escapes string values that are
45 elements of a list, for serialization. Modified Docutils-XML
46 writing (``Element._dom_node``) and pseudo-XML writing
47 (``Element.starttag``) to use ``serial_escape``.
48 - Added ``Node.deepcopy()`` method.
49 - Removed the internal lists ``document.substitution_refs``,
50 ``document.anonymous_refs``, and ``document.anonymous_targets``.
51 - Added a "container" element.
53 * docutils/parsers/null.py: Added to project; a do-nothing parser.
55 * docutils/parsers/rst/__init__.py:
57 - Added validator to tab_width setting, with test. Closes SF bug
58 #1212515, report from Wu Wei.
60 * docutils/parsers/rst/states.py:
62 - Fixed bug with escaped colons indicating a literal block.
63 - Fixed bug with enumerated lists (SF#1254145).
64 - Targets (implicit and explicit), anonymous hyperlink references
65 and auto-numbered footnote references inside of substitution
66 definitions are now disallowed.
68 * docutils/parsers/rst/directives/body.py:
70 - Added the "container" directive.
72 * docutils/parsers/rst/directives/misc.py:
74 - Added the "default-role" and "title" directives.
75 - Added standard data file syntax to the "include" directive.
76 - Added support for "class" directive content.
78 * docutils/parsers/rst/directives/images.py:
80 - Added support for image width and height units.
81 - Fixed bug with image "target" options.
83 * docutils/parsers/rst/include/: Directory added to project; contains
84 standard data files for the "include" directive. Initial contents:
85 character entity substitution definition sets.
87 * docutils/readers/__init__.py:
89 - Added universal.Decorations and universal.ExposeInternals
90 transforms as default transforms for all readers.
91 - Added ``ReReader`` base class for readers that reread an existing
94 * docutils/readers/doctree.py: Added to project; a reader for existing
97 * docutils/transforms/misc.py:
99 - Added misc.Transitions transform, extracted from
100 universal.FinalChecks.
102 * docutils/transforms/references.py:
104 - Added references.DanglingReferences transform, extracted from
105 universal.FinalChecks.
106 - Fixed bug with doubly-indirect substitutions.
108 * docutils/transforms/universal.py:
110 - Added universal.ExposeInternals transform, extracted from
111 universal.FinalChecks.
112 - Removed universal.FinalChecks transform (logic has been moved to
113 several new transforms).
114 - Fixed bug with the "expose_internals" setting and Text nodes
115 (exposed by the "rawsource" internal attribute).
117 * docutils/transforms/writer_aux.py: Added to project; auxiliary
118 transforms for writers.
120 - Added ``Compound`` transform, which flattens compound paragraphs.
122 * docutils/writers/__init__.py:
124 - Added universal.Messages and universal.FilterMessages transforms
125 as default transforms for all writers.
126 - Added ``UnfilteredWriter`` base class for writers that pass the
127 document tree on unchanged.
129 * docutils/writers/docutils_xml.py:
131 - Made ``xmlcharrefreplace`` the default output encoding error
134 * docutils/writers/html4css1.py:
136 - Added support for image width and height units.
137 - Made ``xmlcharrefreplace`` the default output encoding error
139 - A warning is now issued if neither ``--stylesheet`` nor
140 ``--stylesheet-path`` is specified.
141 - Made ``--embed-stylesheet`` the default rather than
142 ``--link-stylesheet``.
143 - Added writer-specific transform to check the stylesheet setting.
144 - Moved "id" attribute from container (section etc.) to title's <a>
145 tag, to be on the same tag as "name".
146 (!!! To be reverted in Docutils 0.5.)
147 - Added vertical space between fields of field lists.
148 - Added ``--compact-field-lists`` option to remove vertical space in
150 - Made cloaking of email addresses with ``--cloak-email-addresses``
153 * docutils/writers/latex2e.py:
155 - Underscores in citekeys are no longer escaped.
157 * docutils/writers/support/: Directory added to project. Modules and
158 data files that support writers have been moved here.
160 The stylesheets are now installed along with the code, the code now
161 knows where to find them, and the default is now to use (actually,
162 to embed) the built-in stylesheets. Some adjustments to
163 configuration files may be necessary. The easiest way to obtain the
164 new default behavior is to remove all settings whose name includes
167 * docutils/writers/support/newlatex2e/unicode_map.py: Added to
168 project; mapping of Unicode characters to LaTeX equivalents.
170 * docs/dev/distributing.txt: Added to project; guide for distributors
171 (package maintainers).
173 * docs/dev/hacking.txt: Added to project; guide for developers.
175 * docs/ref/doctree.txt:
177 - Updated for plural attributes "classes", "ids", "names",
179 - Added the "container" element.
181 * docs/ref/docutils.dtd:
183 - Updated for plural attributes "classes", "ids", "names",
186 * docs/user/links.txt: Added to project; lists of Docutils-related
189 * docs/user/mailing-lists.txt: Added to project; information about
190 Docutils-related mailing lists and how to access them.
192 * docs/ref/rst/substitutions.txt: "reStructuredText Standard
193 Substitution Definition Sets", added to project.
195 * test/coverage.sh: Added to project; test coverage script.
197 * test/DocutilsTestSupport.py:
199 - Added support for specifying runtime settings at the suite level.
201 * tools/rstpep2html.py: Renamed from pep.py.
203 * tools/dev/create_unimap.py: Added to project; script to create the
204 docutils/writers/unimap_latex.py mapping file.
206 * tools/dev/profile_docutils.py: Added to project; profiler script.
208 * tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
210 * tools/stylesheets: Removed from project. Stylesheets have been
211 renamed and moved to docutils/writers/support/ or its
215 Release 0.3.9 (2005-05-26)
216 ==========================
220 - Eliminated and replaced all uses of the old string attributes
221 ``id``, ``name``, ``dupname`` and ``class`` with references to the
222 new list attributes ``ids``, ``names``, ``dupnames`` and
223 ``classes`` throughout the whole source tree.
227 - Enabled ``--dump-*`` options when ``--traceback`` specified,
228 allowing for easier debugging.
230 * docutils/examples.py:
232 - Added ``internals`` function for exploration.
236 - Fixed ``Input.decode`` method to apply heuristics only if no
237 encoding is explicitly given, and to provide better reporting of
239 - The ``Input.decode`` method now removes byte order marks (BOMs)
244 - ``image`` element class changed to subclass of Element, not
245 TextElement (it's an empty element, and cannot contain text).
246 - Added ``attr_defaults`` dictionary for default attribute values.
247 - Added empty list as default value for the following attributes:
248 ``ids``, ``names``, ``dupnames``, ``classes``, and ``backrefs``.
249 - Added ``document.decoration`` attribute,
250 ``document.get_decoration`` method, and ``decoration.get_header``
251 & ``.get_footer`` methods.
252 - Added ``Element.update_basic_atts()`` and ``Element.substitute()``
257 - Removed ``docutils.utils.Reporter.categories``,
258 ``docutils.utils.ConditionSet``, and all references to them, to
259 simplify error reporting.
261 * docutils/languages/nl.py: Added to project; Dutch mappings by
264 * docutils/parsers/rst/__init__.py:
266 - Added settings: ``file_insertion_enabled`` & ``raw_enabled``.
268 * docutils/parsers/rst/states.py:
270 - Added check for escaped at-mark to prevent email address recognition.
271 - Fixed option lists to allow spaces inside ``<angle-bracketed option
273 - Allowed whitespace in paths and URLs.
274 - Added auto-enumerated list items.
275 - Fixed bug that assumed ``.. _`` and ``.. |`` were invariably
277 - Added support for table stub columns.
279 * docutils/parsers/rst/directives/__init__.py:
281 - Allowed whitespace in paths (``path`` function).
282 - Added ``uri`` directive option conversion function.
284 * docutils/parsers/rst/directives/body.py:
286 - Fixed illegal context bug with "topic" directive (allowed within
287 sidebars; not within body elements).
289 * docutils/parsers/rst/directives/images.py:
291 - Allowed whitespace (stripped) in "image" & "figure" directive URLs.
292 - Added support for the ``file_insertion_enabled`` setting in the
293 "figure" directive (disables "figwidth" option).
294 - "image" directive: added checks for valid values of "align" option,
295 depending on context. "figure" directive: added specialized
296 "align" option and attribute on "figure" element.
297 - Made ":figwidth: image" option of "figure" directive work again.
298 - Fixed bug with reference names containing uppercase letters
299 (e.g. ``Name_``) in "target" option of "image" directive.
301 * docutils/parsers/rst/directives/misc.py:
303 - Fixed "include" and "raw" directives to catch text decoding
305 - Allowed whitespace in "include" & "raw" directive paths.
306 - Added support for ``file_insertion_enabled`` & ``raw_enabled``
307 settings in "include" & "raw" directives.
309 * docutils/parsers/rst/directives/parts.py:
311 - Added "header" & "footer" directives.
312 - Fixed illegal context bug with "contents" directive (topics
313 allowed within sidebars; not within body elements).
315 * docutils/parsers/rst/directives/tables.py:
317 - Added "list-table" directive.
318 - Caught empty CSV table bug.
319 - Added support for the ``file_insertion_enabled`` setting in the
320 "csv-table" directive.
321 - Added ``stub-columns`` option to "csv-table" and "list-table"
324 * docutils/parsers/rst/languages/nl.py: Added to project; Dutch
325 mappings by Martijn Pieters.
327 * docutils/readers/standalone.py:
329 - Added ``--section-subtitles`` and ``--no-section-subtitles``
330 options to activate or deactivate the SectSubTitle transform.
332 * docutils/transforms/frontmatter.py:
334 - Added SectSubTitle transform to promote titles of lone
335 subsections to subtitles.
337 * docutils/transforms/references.py:
339 - Fixed mislocated internal targets bug, by propagating internal
340 targets to the next node, making use of the newly added support
341 for multiple names and IDs.
342 - Fixed duplicate footnote label bug.
343 - Replaced ``ChainedTargets`` with more generic ``PropagateTargets``
346 * docutils/writers/html4css1.py:
348 - Fixed unencoded stylesheet reference bug (characters like "&" in
349 stylesheet references).
350 - ``target`` nodes now appear as ``span`` tags (instead of ``a``
352 - Added support for multiple IDs per node by creating empty ``span``
354 - Added the ``field_name_limit`` & ``option_limit`` settings &
356 - Added support for table stub columns.
357 - Added support for the ``align`` attribute on ``figure`` elements.
358 - Added the ``cloak_email_addresses`` setting & support.
359 - Added ``html_prolog``, ``html_head``, ``html_body``,
360 ``html_title``, & ``html_subtitle`` to parts dictionary exposed by
361 ``docutils.core.publish_parts``.
362 - Added support for section subtitles.
364 * docutils/writers/latex2e.py:
366 - Fixed tables starting with more than one multirow cell.
367 - Improved --use-latex-docinfo so that organization/contact/address
368 fields are lumped with the last author field and appear on the
370 - Made sure the titlepage is always shown with --use-latex-docinfo,
371 even if the document has no title.
372 - Made sure that latex doesn't fill in today's date if no date field
374 - Added support for section subtitles.
376 * docutils/writers/null.py: Added to project; a do-nothing Writer.
378 * docs/api/publisher.txt:
380 - Added "``publish_parts`` Details" section.
382 * docutils/dev/repository.txt: Added to project; information about the
383 Docutils Subversion repository.
385 * docs/ref/docutils.dtd:
387 - Added a ``stub`` attribute to the ``colspec`` element via the
388 ``tbl.colspec.att`` parameter entity.
389 - Allowed topic elements within sidebars
390 - Added an ``align`` attribute to the ``figure`` element.
393 Release 0.3.7 (2004-12-24)
394 ==========================
396 * docutils/frontend.py:
398 - Added options: --input-encoding-error-handler,
399 --record-dependencies, --leave-footnote-reference-space,
401 - Added command-line and config file support for "overrides" setting
406 - Added support for input encoding error handler.
410 - Added dispatch_visit and dispatch_departure methods to
411 NodeVisitor; useful as a hook for Visitors.
412 - Changed structure of ``line_block``; added ``line``.
413 - Added ``compound`` node class.
414 - Added a mechanism for Visitors to transitionally ignore new node
419 - Moved ``escape2null`` and ``unescape`` functions from
420 docutils/parsers/rst/states.py.
422 * docutils/parsers/rst/roles.py:
425 - Changed role function API: the "text" parameter now takes
426 null-escaped interpreted text content.
428 * docutils/parsers/rst/states.py:
430 - Fixed bug where a "role" directive in a nested parse would crash
431 the parser; the state machine's "language" attribute was not being
433 - Added support for line block syntax.
434 - Fixed directive parsing bug: argument-less directives didn't
435 notice that arguments were present.
436 - Removed error checking for transitions.
437 - Added support for multiple classifiers in definition list items.
438 - Moved ``escape2null`` and ``unescape`` functions to docutils/utils.py.
439 - Changed role function API: the "text" parameter now takes
440 null-escaped interpreted text content.
441 - Empty sections and documents are allowed now.
443 * docutils/parsers/rst/directives/__init__.py:
445 - Added ``encoding`` directive option conversion function.
446 - Allow multiple class names in class_option conversion function.
448 * docutils/parsers/rst/directives/body.py:
450 - Converted the line-block directive to use the new structure.
451 - Extracted the old line-block functionality to the ``block``
452 function (still used).
453 - Added ``compound`` directive (thanks to Felix Wiemann).
455 * docutils/parsers/rst/directives/misc.py:
457 - Added "encoding" option to "include" and "raw" directives.
458 - Added "trim", "ltrim", and "rtrim" options to "unicode" directive.
459 - Allow multiple class names in the "class" directive.
461 * docutils/parsers/rst/directives/parts.py:
463 - Directive "sectnum" now accepts "prefix", "suffix", and "start"
464 options. Thanks to Lele Gaifax.
466 * docutils/parsers/rst/directives/tables.py:
468 - Added "encoding" directive to "csv-table" directive.
469 - Added workaround for lack of Unicode support in csv.py, for
472 * docutils/transforms/misc.py:
474 - Fixed bug when multiple "class" directives are applied to a single
476 - Enabled multiple format names for "raw" directive.
478 * docutils/transforms/references.py:
480 - Added support for trimming whitespace from beside substitution
483 * docutils/transforms/universal.py:
485 - FinalChecks now checks for illegal transitions and moves
486 transitions between sections.
488 * docutils/writers/html4css1.py:
490 - HTMLTranslator.encode now converts U+00A0 to " ".
491 - "stylesheet" and "stylesheet_path" settings are now mutually
493 - Added support for the new line_block/line structure.
494 - --footnote-references now overrides
495 --trim-footnote-reference-space, if applicable.
496 - Added support for ``compound`` elements.
497 - Enabled multiple format names for "raw" directive.
498 - ``<p>`` tags of a paragraph which is the only visible child of the
499 document node are no longer stripped.
500 - Moved paragraph-compacting logic (for stripping ``<p>`` tags) to
501 new method ``should_be_compact_paragraph()``.
502 - Added class="docutils" to ``dl``, ``hr``, ``table`` and ``tt``
504 - "raw" elements are now surrounded by ``span`` or ``div`` tags in
505 the output if they have their ``class`` attribute set.
506 - The whole document is now surrounded by a ``<div
507 class="document">`` element.
508 - Body-level images are now wrapped by their own ``<div>`` elements,
509 with image classes copied to the wrapper, and for images which
510 have the ``:align:`` option set, the surrounding ``<div>`` now
511 receives a class attribute (like ``class="align-left"``).
513 * docutils/writers/latex2e.py:
515 - no newline after depart_term.
516 - Added translations for some Unicode quotes.
517 - Added option "font-encoding", made package AE the default.
518 - "stylesheet" and "stylesheet_path" settings are now mutually
520 - --footnote-references now overrides
521 --trim-footnote-reference-space, if applicable.
522 - The footnote label style now matches the footnote reference style
523 ("brackets" or "superscript").
524 - Added support for ``compound`` elements.
525 - Enabled multiple format names for "raw" directive.
527 * docs/ref/docutils.dtd:
529 - Changed structure of the ``line_block`` element; added ``line``.
530 - Added ``compound`` element.
531 - Added "ltrim" and "rtrim" attributes to
532 ``substitution_definition`` element.
533 - Enabled multiple format names for ``raw`` element.
534 - Enabled multiple classifiers in ``definition_list_item`` elements.
536 * docs/ref/rst/directives.txt
538 - Marked "line-block" as deprecated.
539 - "Class" directive now allows multiple class names.
540 - Added "Rationale for Class Attribute Value Conversion".
541 - Added warning about "raw" overuse/abuse.
543 * docs/ref/rst/restructuredtext.txt:
545 - Added syntax for line blocks.
546 - Definition list items may have multiple classifiers.
548 * docs/ref/rst/roles.txt:
552 * tools/stylesheets/default.css:
554 - Added support for the new line_block structure.
555 - Added "docutils" class to ``dl``, ``hr``, ``table`` and ``tt``.
558 Release 0.3.5 (2004-07-29)
559 ==========================
563 * _`Documentation cleanup/reorganization`.
565 - Created new subdirectories of docs/:
567 * ``docs/user/``: introductory/tutorial material for end-users
568 * ``docs/dev/``: for core-developers (development notes, plans, etc.)
569 * ``docs/api/``: API reference material for client-developers
570 * ``docs/ref/``: reference material for all groups
571 * ``docs/howto/``: for component-developers and core-developers
572 * ``docs/peps/``: Python Enhancement Proposals
574 - Moved ``docs/*`` to ``docs/user/``.
575 - Moved ``pysource.dtd``, ``pysource.txt``, ``semantics.txt`` from
576 ``spec/`` to ``docs/dev``.
577 - Moved ``doctree.txt``, ``docutils.dtd``, ``soextblx.dtd``,
578 ``transforms.txt`` from ``spec/`` to ``docs/ref/``.
579 - Moved ``alternatives.txt``, and ``problems.txt`` from
580 ``spec/rst/`` to ``docs/dev/rst/``.
581 - Moved ``reStructuredText.txt``, ``directives.txt``,
582 ``interpreted.txt``, and ``introduction.txt`` from ``spec/rst/``
583 to ``docs/ref/rst/``. Renamed ``interpreted.txt`` to
584 ``roles.txt``, ``reStructuredText.txt`` to
585 ``restructuredtext.txt``.
586 - Moved ``spec/howto/`` to ``docs/howto``.
588 In order to keep the CVS history of moved files, we supplied
589 SourceForge with a `script for modifying the Docutils CVS
592 __ http://cvs.sourceforge.net/viewcvs.py/*checkout*/docutils/sandbox/davidg/infrastructure/cvs-reorg.sh?content-type=text/plain&rev=1.5
594 After running the cleanup script:
596 - Added ``docs/index.txt``.
597 - Added a ``.htaccess`` file to the ``web`` module, containing
598 redirects for all old paths to new paths. They'll preserve
599 fragments (the "#name" part of a URL), and won't clutter up the
600 file system, and will correct the URL in the user's browser.
601 - Added ``BUGS.txt``, ``docs/dev/policies.txt``,
602 ``docs/dev/website.txt``, ``docs/dev/release.txt`` from all but
603 the "To Do" list itself in ``docs/dev/todo.txt``.
604 - Moved "Future Plans" from ``HISTORY.txt`` to new "Priorities"
605 section of ``docs/dev/todo.txt``.
606 - Added ``THANKS.txt`` from "Acknowledgements" in ``HISTORY.txt``.
607 - Added "How To Report Bugs" to ``BUGS.txt``.
608 - Went through all the sources and docs (including under web/) and
609 updated links. Mostly done by Felix Wiemann; thanks Felix!
610 (Still need to update links in the sandboxes.)
614 * BUGS.txt: Added to project.
616 * THANKS.txt: Added to project.
618 * docutils/__init__.py:
620 - 0.3.4: Post-release.
624 - Added special error handling & advice for UnicodeEncodeError.
625 - Refactored Publisher.publish (simplified exception handling &
626 extracted debug dumps).
627 - Renamed "enable_exit" parameter of convenience functions to
628 "enable_exit_status".
629 - Enabled traceback (exception propagation) by default in
630 programmatic convenience functions.
631 - Now publish_file and publish_cmdline convenience functions return
632 the encoded string results in addition to their regular I/O.
633 - Extracted common code from publish_file, publish_string, and
634 publish_parts, into new publish_programmatically. Extracted
635 settings code to ``Publisher.process_programmatic_settings``.
636 - In Publisher.publish, disabled ``settings_overrides`` when
637 ``settings`` is supplied; redundant.
639 * docutils/frontend.py:
641 - Added help text for "--output-encoding-error-handler" and
642 "--error-encoding-error-handler".
643 - Renamed "--exit" to "--exit-status".
644 - Simplified default-setting code.
646 * docutils/parsers/rst/__init__.py:
648 - Added "--pep-base-url" and "--rfc-base-url" options.
650 * docutils/parsers/rst/states.py:
652 - Made URI recognition more aggressive and intelligent.
654 * docutils/parsers/rst/directives/__init__.py:
656 - Added several directive option conversion functions.
658 * docutils/parsers/rst/directives/body.py:
660 - Moved "table" directive to tables.py.
662 * docutils/parsers/rst/directives/tables.py: Table-related directives,
665 * docutils/writers/latex2e.py:
667 - Added "--table-style=(standard|booktabs|nolines)"
668 - figures get "here" option (LaTeX per default puts them at bottom),
669 and figure content is centered.
670 - Rowspan support for tables.
671 - Fix: admonition titles before first section.
672 - Replace ``--`` in literal by ``-{}-`` because fontencoding T1 has endash.
673 - Replave ``_`` in literal by an underlined blank, because it has the correct
675 - Fix: encode pdfbookmark titles, ``#`` broke pdflatex.
676 - A few unicode replacements, if output_encoding != utf
677 - Add "--graphicx-option".
678 - Indent literal-blocks.
679 - Fix: omit ``\maketitle`` when there is no document title.
681 * docs/index.txt: "Docutils Project Documentation Overview", added to
684 * docs/api/cmdline-tool.txt: "Inside A Docutils Command-Line Front-End
685 Tool", added to project.
687 * docs/api/publisher.txt: "The Docutils Publisher", added to project.
689 * docs/api/runtime-settings.txt: "Docutils Runtime Settings", added to project.
691 * docs/dev/policies.txt: Added to project (extracted from
692 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
694 * docs/dev/release.txt: Added to project (extracted from
695 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
697 * docs/dev/testing.txt: Added to project.
699 * docs/dev/website.txt: Added to project (extracted from
700 ``docs/dev/todo.txt``, formerly ``spec/notes.txt``).
702 * docs/ref/rst/directives.txt:
704 - Added directives: "table", "csv-table".
706 * docs/user/rst/cheatsheet.txt: "The reStructuredText Cheat Sheet"
707 added to project. 1 page for syntax, and a 1 page reference for
708 directives and roles. Source text to be used as-is; not meant to be
711 * docs/user/rst/demo.txt: Added to project; moved from tools/test.txt
712 with a change of title.
714 * test/functional/, contents, and test/test_functional.py: Added to
717 * tools/buildhtml.py: Fixed bug with config file handling.
719 * tools/html.py: Removed from project (duplicate of rst2html.py).
721 * tools/pep2html.py: Removed from project (duplicate of Python's
722 nondist/peps/pep2html.py; Docutils' tools/pep.py can be used for
723 Docutils-related PEPs in docs/peps/).
725 * tools/rst2pseudoxml.py: Renamed from publish.py.
727 * tools/rst2xml.py: Renamed from docutils-xml.py.
729 * tools/test.txt: Removed from project; moved to
730 docs/user/rst/demo.txt.
732 * setup.py: Now also installs ``rst2latex.py``.
735 Release 0.3.3 (2004-05-09)
736 ==========================
738 * docutils/__init__.py:
740 - 0.3.1: Reorganized config file format (multiple sections); see
742 - Added unknown_reference_resolvers attribute to TransformSpec.
743 - 0.3.2: Interpreted text reorganization.
748 - Catch system messages to stop tracebacks from parsing errors.
749 - Catch exceptions during processing report & exit without
750 tracebacks, except when "--traceback" used.
751 - Reordered components for OptionParser; application comes last.
752 - Added "config_section" parameter to several methods and functions,
753 allowing front ends to easily specify their config file sections.
754 - Added publish_parts convenience function to allow access to individual
757 * docutils/examples.py: Added to project; practical examples of
758 Docutils client code, to be used as-is or as models for variations.
760 * docutils/frontend.py:
762 - Added "--traceback" & "--no-traceback" options ("traceback"
764 - Implemented support for config file reorganization:
765 ``standard_config_files`` moved from ``ConfigParser`` to
766 ``OptionParser``; added
767 ``OptionParser.get_config_file_settings()`` and
768 ``.get_standard_config_settings()``; support for old "[options]"
769 section (with deprecation warning) and mapping from old to new
771 - Reimplemented setting validation.
772 - Enabled flexible boolean values: yes/no, true/false, on/off.
773 - Added ``Values``, a subclass of ``optparse.Values``, with support
774 for list setting attributes.
775 - Added support for new ``DOCUTILSCONFIG`` environment variable;
776 thanks to Beni Cherniavsky.
777 - Added "--no-section-numbering" option.
781 - Catch IOErrors when opening source & destination files, report &
782 exit without tracebacks. Added ``handle_io_errors`` parameter to
783 ``FileInput`` & ``FileOutput`` to enable caller error handling.
787 - Changed ``SparseNodeVisitor`` and ``GenericNodeVisitor`` dynamic
788 method definitions (via ``exec``) to dynamic assignments (via
789 ``setattr``); thanks to Roman Suzi.
790 - Encapsulated visitor dynamic assignments in a function; thanks to
792 - Added indirect_reference_name attribute to the Targetable
793 class. This attribute holds the whitespace_normalized_name
794 (contains mixed case) of a target.
796 * docutils/statemachine.py:
798 - Renamed ``StringList.strip_indent`` to ``.trim_left``.
799 - Added ``StringList.get_2D_block``.
803 - Added "level" attribute to SystemMessage exceptions.
805 * docutils/languages/af.py: Added to project; Afrikaans mappings by
808 * docutils/languages/cs.py: Added to project; Czech mappings by Marek
811 * docutils/languages/eo.py: Added to project; Esperanto mappings by
812 Marcelo Huerta San Martin.
814 * docutils/languages/pt_br.py: Added to project; Brazilian Portuguese
815 mappings by Lalo Martins.
817 * docutils/languages/ru.py: Added to project; Russian mappings by
820 * docutils/parsers/rst/roles.py: Added to project. Contains
821 interpreted text role functions, a registry for interpreted text
822 roles, and an API for adding to and retrieving from the registry.
823 Contributed by Edward Loper.
825 * docutils/parsers/rst/states.py:
827 - Updated ``RSTState.nested_parse`` for "include" in table cells.
828 - Allowed true em-dash character and "---" as block quote
830 - Added support for <angle-bracketed> complex option arguments
832 - Fixed handling of backslashes in substitution definitions.
833 - Fixed off-by-1 error with extra whitespace after substitution
834 definition directive.
835 - Added inline markup parsing to field lists' field names.
836 - Added support for quoted (and unindented) literal blocks.
837 Driven in part by a bribe from Frank Siebenlist (thanks!).
838 - Parser now handles escapes in URIs correctly.
839 - Made embedded-URIs' reference text omittable. Idea from Beni
841 - Refactored explicit target processing code.
842 - Added name attribute to references containing the reference name only
843 through whitespace_normalize_name (no case changes).
844 - parse_target no longer returns the refname after going through
845 normalize_name. This is now handled in make_target.
846 - Fixed bug relating to role-less interpreted text in non-English
848 - Reorganized interpreted text processing; moved code into the new
849 roles.py module. Contributed by Edward Loper.
850 - Refactored ``Body.parse_directive`` into ``run_directive`` and
851 ``parse_directive_block``.
853 * docutils/parsers/rst/tableparser.py:
855 - Reworked for ``StringList``, to support "include" directives in
858 * docutils/parsers/rst/directives/__init__.py:
860 - Renamed ``unchanged()`` directive option conversion function to
861 ``unchanged_required``, and added a new ``unchanged``.
862 - Catch unicode value too high error; fixes bug 781766.
863 - Beefed up directive error reporting.
865 * docutils/parsers/rst/directives/body.py:
867 - Added basic "table" directive.
869 * docutils/parsers/rst/directives/images.py:
871 - Added "target" option to "image" directive.
872 - Added name attribute to references containing the reference name only
873 through whitespace_normalize_name (no case changes).
875 * docutils/parsers/rst/directives/misc.py:
877 - Isolated the import of the ``urllib2`` module; was causing
878 problems on SourceForge (``libssl.so.2`` unavailable?).
879 - Added the "role" directive for declaring custom interpreted text
882 * docutils/parsers/rst/directives/parts.py:
884 - The "contents" directive does more work up-front, creating the
885 "topic" and "title", and leaving the "pending" node for the
886 transform. Allows earlier reference resolution; fixes subtle bug.
888 * docutils/parsers/rst/languages/af.py: Added to project; Afrikaans
889 mappings by Jannie Hofmeyr.
891 * docutils/parsers/rst/languages/cs.py: Added to project; Czech
892 mappings by Marek Blaha.
894 * docutils/parsers/rst/languages/eo.py: Added to project; Esperanto
895 mappings by Marcelo Huerta San Martin.
897 * docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian
898 Portuguese mappings by Lalo Martins.
900 * docutils/parsers/rst/languages/ru.py: Added to project; Russian
901 mappings by Roman Suzi.
903 * docutils/transforms/parts.py:
905 - The "contents" directive does more work up-front, creating the
906 "topic" and "title", and leaving the "pending" node for the
907 transform. Allows earlier reference resolution; fixes subtle bug.
908 - Added support for disabling of section numbering.
910 * docutils/transforms/references.py:
912 - Verifying that external targets are truly targets and not indirect
913 references. This is because we are now adding a "name" attribute to
914 references in addition to targets. Note sure if this is correct!
915 - Added code to hook into the unknown_reference_resolvers list for a
916 transformer in resolve_indirect_target. This allows the
917 unknown_reference_resolvers to keep around indirect targets which
918 docutils doesn't know about.
919 - Added specific error message for duplicate targets.
921 * docutils/transforms/universal.py:
923 - Added FilterMessages transform (removes system messages below the
924 verbosity threshold).
925 - Added hook (via docutils.TransformSpec.unknown_reference_resolvers)
926 to FinalCheckVisitor for application-specific handling of
927 unresolvable references.
928 - Added specific error message for duplicate targets.
930 * docutils/writers/__init__.py:
932 - Added assemble_parts method to the Writer class to allow for
933 access to a documents individual parts.
934 - Documented & set default for ``Writer.output`` attribute.
936 * docutils/writers/html4css1.py:
938 - Fixed unicode handling of attribute values (bug 760673).
939 - Prevent duplication of "class" attribute values (bug report from
941 - Improved table grid/border handling (prompted by report from Bob
943 - Added support for table titles.
944 - Added "<title />" for untitled docs, for XHTML conformance; thanks
946 - Added functionality to keep track of individual parts of a document
947 and store them in a dictionary as the "parts" attribute of the writer.
948 Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
949 - Added proper support for the "scale" attribute of the "image"
950 element. Contributed by Brent Cook.
951 - Added ``--initial-header-level`` option.
952 - Fixed bug: the body_pre_docinfo segment depended on there being a
953 docinfo; if no docinfo, the document title was incorporated into
954 the body segment. Adversely affected the publish_parts interface.
956 * docutils/writers/latex2e.py:
958 - Changed default stylesheet to "no stylesheet" to avoid latex complaining
959 about a missing file.
960 - Added options and support: ``--compound-enumerators``,
961 ``--section-prefix-for-enumerators``, and
962 ``--section-enumerator-separator``. By John F Meinel Jr (SF patch
964 - Added option ``--use-verbatim-when-possible``, to avoid
965 problematic characters (eg, '~' in italian) in literal blocks.
966 - It's now possible to use four section levels in the `book` and
967 `report` LaTeX classes. The default `article` class still has
970 * docs/config.txt: "Docutils Configuration Files", added to project.
971 Moved config file entry descriptions from tools.txt.
975 - Moved config file entry descriptions to config.txt.
977 * spec/notes.txt: Continual updates. Added "Setting Up For Docutils
980 * spec/howto/rst-roles.txt: "Creating reStructuredText Interpreted
981 Text Roles", added to project.
983 * spec/rst/reStructuredText.txt:
985 - Added description of support for <angle-bracketed> complex option
986 arguments to option lists.
987 - Added subsections for indented and quoted literal blocks.
989 * test: Continually adding & updating tests.
991 - Added test/test_settings.py & test/data/config_*.txt support
993 - Added test/test_writers/test_htmlfragment.py.
995 * test/DocutilsTestSupport.py:
997 - Refactored LaTeX publisher test suite/case class names to make
998 testing other writers easier.
999 - Added HtmlWriterPublishTestCase and HtmlFragmentTestSuite classes
1000 to test the processing of HTML fragments which use the new
1001 publish_parts convenience function.
1003 * tools/buildhtml.py:
1005 - Added support for the "--prune" option.
1006 - Removed dependency on pep2html.py; plaintext PEPs no longer
1009 * tools/docutils.conf:
1011 - Updated for configuration file reorganization.
1013 * tools/rst2html.py:
1015 - copied from tools/html.py
1019 - added a 'scripts' section to configuration
1020 - added 'tools/rst2html.py' to the scripts section
1023 Release 0.3 (2003-06-24)
1024 ========================
1028 * Renamed "attribute" to "option" for directives/extensions.
1030 * Renamed transform method "transform" to "apply".
1032 * Renamed "options" to "settings" for runtime settings (as set by
1033 command-line options). Sometimes "option" (singular) became
1034 "settings" (plural). Some variations below:
1036 - document.options -> document.settings (stored in other objects as
1038 - option_spec -> settings_spec (not directives though)
1039 - OptionSpec -> SettingsSpec
1040 - cmdline_options -> settings_spec
1041 - relative_path_options -> relative_path_settings
1042 - option_default_overrides -> settings_default_overrides
1043 - Publisher.set_options -> Publisher.get_settings
1047 * COPYING.txt: Added "Public Domain Dedication".
1049 * FAQ.txt: Frequently asked questions, added to project.
1053 - Updated with PyPI Trove classifiers.
1054 - Conditional installation of third-party modules.
1056 * docutils/__init__.py:
1058 - Bumped version to 0.2.1 to reflect changes to I/O classes.
1059 - Bumped version to 0.2.2 to reflect changes to stylesheet options.
1060 - Factored ``SettingsSpec`` out of ``Component``; separately useful.
1061 - Bumped version to 0.2.3 because of the new "--embed-stylesheet"
1062 option and its effect on the PEP template & writer.
1063 - Bumped version to 0.2.4 due to changes to the PEP template &
1065 - Bumped version to 0.2.5 to reflect changes to Reporter output.
1066 - Added ``TransformSpec`` class for new transform system.
1067 - Bumped version to 0.2.6 for API changes (renaming).
1068 - Bumped version to 0.2.7 for new ``docutils.core.publish_*``
1069 convenience functions.
1070 - Added ``Component.component_type`` attribute.
1071 - Bumped version to 0.2.8 because of the internal parser switch from
1072 plain lists to the docutils.statemachine.StringList objects.
1073 - Bumped version to 0.2.9 because of the frontend.py API changes.
1074 - Bumped version to 0.2.10 due to changes to the project layout
1075 (third-party modules removed from the "docutils" package), and
1076 signature changes in ``io.Input``/``io.Output``.
1077 - Changed version to 0.3.0 for release.
1081 - Made ``publish()`` a bit more convenient.
1082 - Generalized ``Publisher.set_io``.
1083 - Renamed ``publish()`` to ``publish_cmdline()``; rearranged its
1084 parameters; improved its docstring.
1085 - Added ``publish_file()`` and ``publish_string()``.
1086 - Factored ``Publisher.set_source()`` and ``.set_destination()``
1088 - Added support for "--dump-pseudo-xml", "--dump-settings", and
1089 "--dump-transforms" hidden options.
1090 - Added ``Publisher.apply_transforms()`` method.
1091 - Added ``Publisher.set_components()`` method; support for
1092 ``publish_*()`` conveninece functions.
1093 - Moved config file processing to docutils/frontend.py.
1094 - Added support for exit status ("exit_level" setting &
1095 ``enable_exit`` parameter for Publisher.publish() and convenience
1098 * docutils/frontend.py:
1100 - Check for & exit on identical source & destination paths.
1101 - Fixed bug with absolute paths & "--config".
1102 - Set non-command-line defaults in ``OptionParser.__init__()``:
1103 ``_source`` & ``_destination``.
1104 - Distributed ``relative_path_settings`` to components; updated
1105 ``OptionParser.populate_from_components()`` to combine it all.
1106 - Require list of keys in ``make_paths_absolute`` (was implicit in
1107 global ``relative_path_settings``).
1108 - Added "--expose-internal-attribute", "--dump-pseudo-xml",
1109 "--dump-settings", and "--dump-transforms" hidden options.
1110 - Removed nasty internals-fiddling ``ConfigParser.get_section``
1111 code, replaced with correct code.
1112 - Added validation functionality for config files.
1113 - Added "--error-encoding" option/setting, "_disable_config"
1115 - Added encoding validation; updated "--input-encoding" and
1116 "--output-encoding"; added "--error-encoding-error-handler" and
1117 "--output-encoding-error-handler".
1118 - Moved config file processing from docutils/core.py.
1119 - Updated ``OptionParser.populate_from_components`` to handle new
1120 ``SettingsSpec.settings_defaults`` dict.
1121 - Added support for "-" => stdin/stdout.
1122 - Added "exit_level" setting ("--exit" option).
1126 - Split ``IO`` classes into subclasses of ``Input`` and ``Output``.
1127 - Added automatic closing to ``FileInput`` and ``FileOutput``.
1128 - Delayed opening of ``FileOutput`` file until ``write()`` called.
1129 - ``FileOutput.write()`` now returns the encoded output string.
1130 - Try to get path/stream name automatically in ``FileInput`` &
1132 - Added defaults for source & destination paths.
1133 - Allow for Unicode I/O with an explicit "unicode" encoding.
1134 - Added ``Output.encode()``.
1135 - Removed dependency on runtime settings; pass encoding directly.
1136 - Recognize Unicode strings in ``Input.decode()``.
1137 - Added support for output encoding error handlers.
1139 * docutils/nodes.py:
1141 - Added "Invisible" element category class.
1142 - Changed ``Node.walk()`` & ``.walkabout()`` to permit more tree
1143 modification during a traversal.
1144 - Added element classes: ``line_block``, ``generated``, ``address``,
1145 ``sidebar``, ``rubric``, ``attribution``, ``admonition``,
1146 ``superscript``, ``subscript``, ``inline``
1147 - Added support for lists of nodes to ``Element.insert()``.
1148 - Fixed parent linking in ``Element.replace()``.
1149 - Added new abstract superclass ``FixedTextElement``; adds
1150 "xml:space" attribute.
1151 - Added support for "line" attribute of ``system_message`` nodes.
1152 - Added support for the observer pattern from ``utils.Reporter``.
1153 Added ``parse_messages`` and ``transform_messages`` attributes to
1154 ``document``, removed ``messages``. Added ``note_parse_message``
1155 and ``note_transform_message`` methods.
1156 - Added support for improved diagnostics:
1158 - Added "document", "source", and "line" internal attributes to
1159 ``Node``, set by ``Node.setup_child()``.
1160 - Converted variations on ``node.parent = self`` to
1161 ``self.setup_child(node)``.
1162 - Added ``document.current_source`` & ``.current_line``
1163 attributes, and ``.note_source`` observer method.
1164 - Changed "system_message" output to GNU-Tools format.
1166 - Added a "rawsource" attribute to the ``Text`` class, for text
1167 before backslash-escape resolution.
1168 - Support for new transform system.
1169 - Reworked ``pending`` element.
1170 - Fixed XML DOM bug (SF #660611).
1171 - Removed the ``interpeted`` element class and added
1172 ``title_reference``, ``abbreviation``, ``acronym``.
1173 - Made substitutions case-sensitive-but-forgiving; moved some code
1175 - Fixed Unicode bug on element attributes (report: William Dode).
1177 * docutils/optik.py: Removed from project; replaced with
1178 extras/optparse.py and extras/textwrap.py. These will be installed
1179 only if they're not already present in the Python installation.
1181 * docutils/roman.py: Moved to extras/roman.py; this will be installed
1182 only if it's not already present in the Python installation.
1184 * docutils/statemachine.py:
1186 - Factored out ``State.add_initial_transitions()`` so it can be
1188 - Converted whitespace-specific "blank" and "indent" transitions
1189 from special-case code to ordinary transitions: removed
1190 ``StateMachineWS.check_line()`` & ``.check_whitespace()``, added
1191 ``StateWS.add_initial_transitions()`` method, ``ws_patterns`` &
1192 ``ws_initial_transitions`` attributes.
1193 - Removed ``State.match_transition()`` after merging it into
1195 - Added ``StateCorrection`` exception.
1196 - Added support for ``StateCorrection`` in ``StateMachine.run()``
1197 (moved ``TransitionCorrection`` support there too.)
1198 - Changed ``StateMachine.next_line()`` and ``.goto_line()`` to raise
1199 ``EOFError`` instead of ``IndexError``.
1200 - Added ``State.no_match`` method.
1201 - Added support for the Observer pattern, triggered by input line
1203 - Added ``strip_top`` parameter to
1204 ``StateMachineWS.get_first_known_indented``.
1205 - Made ``context`` a parameter to ``StateMachine.run()``.
1206 - Added ``ViewList`` & ``StringList`` classes;
1207 ``extract_indented()`` becomes ``StringList.get_indented()``.
1208 - Added ``StateMachine.insert_input()``.
1209 - Fixed ViewList slice handling for Python 2.3. Patch from (and
1210 thanks to) Fred Drake.
1212 * docutils/utils.py:
1214 - Added a ``source`` attribute to Reporter instances and
1215 ``system_message`` elements.
1216 - Added an observer pattern to ``utils.Reporter`` to keep track of
1218 - Fixed bugs in ``relative_path()``.
1219 - Added support for improved diagnostics.
1220 - Moved ``normalize_name()`` to nodes.py (``fully_normalize_name``).
1221 - Added support for encoding Reporter stderr output, and encoding
1223 - Reporter keeps track of the highest level system message yet
1226 * docutils/languages: Fixed bibliographic field language lookups.
1228 * docutils/languages/es.py: Added to project; Spanish mappings by
1229 Marcelo Huerta San Martin.
1231 * docutils/languages/fr.py: Added to project; French mappings by
1234 * docutils/languages/it.py: Added to project; Italian mappings by
1237 * docutils/languages/sk.py: Added to project; Slovak mappings by
1240 * docutils/parser/__init__.py:
1242 - Added ``Parser.finish_parse()`` method.
1244 * docutils/parser/rst/__init__.py:
1246 - Added options: "--pep-references", "--rfc-references",
1247 "--tab-width", "--trim-footnote-reference-space".
1249 * docutils/parsers/rst/states.py:
1251 - Changed "title under/overline too short" system messages from INFO
1252 to WARNING, and fixed its insertion location.
1253 - Fixed enumerated list item parsing to allow paragraphs & section
1254 titles to begin with enumerators.
1255 - Converted system messages to use the new "line" attribute.
1256 - Fixed a substitution reference edge case.
1257 - Added support for "--pep-references" and "--rfc-references"
1258 options; reworked ``Inliner`` code to make customization easier.
1259 - Removed field argument parsing.
1260 - Added support for short section title over/underlines.
1261 - Fixed "simple reference name" regexp to ignore text like
1262 "object.__method__"; not an anonymous reference.
1263 - Added support for improved diagnostics.
1264 - Reworked directive API, based on Dethe Elza's contribution. Added
1265 ``Body.parse_directive()``, ``.parse_directive_options()``,
1266 ``.parse_directive_arguments()`` methods.
1267 - Added ``ExtensionOptions`` class, to parse directive options
1268 without parsing field bodies. Factored
1269 ``Body.parse_field_body()`` out of ``Body.field()``, overridden in
1270 ``ExtensionOptions``.
1271 - Improved definition list term/classifier parsing.
1272 - Added warnings for unknown directives.
1273 - Renamed ``Stuff`` to ``Struct``.
1274 - Now flagged as errors: transitions at the beginning or end of
1275 sections, empty sections (except title), and empty documents.
1276 - Updated for ``statemachine.StringList``.
1277 - Enabled recognition of schemeless email addresses in targets.
1278 - Added support for embedded URIs in hyperlink references.
1279 - Added backslash-escapes to inline markup end-string suffix.
1280 - Added support for correct interpreted text processing.
1281 - Fixed nested title parsing (topic, sidebar directives).
1282 - Added special processing of backslash-escaped whitespace (idea
1283 from David Abrahams).
1284 - Made substitutions case-sensitive-but-forgiving; moved some code
1285 to ``docutils.nodes``.
1286 - Added support for block quote attributions.
1287 - Added a kludge to work-around a conflict between the bubble-up
1288 parser strategy and short titles (<= 3 char-long over- &
1289 underlines). Fixes SF bug #738803 "infinite loop with multiple
1290 titles" submitted by Jason Diamond.
1291 - Added explicit interpreted text roles for standard inline markup:
1292 "emphasis", "strong", "literal".
1293 - Implemented "superscript" and "subscript" interpreted text roles.
1294 - Added initial support for "abbreviation" and "acronym" roles;
1296 - Added support for "--trim-footnote-reference-space" option.
1297 - Optional space before colons in directives & hyperlink targets.
1299 * docutils/parsers/rst/tableparser.py:
1301 - Fixed a bug that was producing unwanted empty rows in "simple"
1303 - Detect bad column spans in "simple" tables.
1305 * docutils/parsers/rst/directives: Updated all directive functions to
1308 * docutils/parsers/rst/directives/__init__.py:
1310 - Added ``flag()``, ``unchanged()``, ``path()``,
1311 ``nonnegative_int()``, ``choice()``, and ``class_option()``
1312 directive option helper functions.
1313 - Added warnings for unknown directives.
1314 - Return ``None`` for missing directives.
1315 - Added ``register_directive()``, thanks to William Dode and Paul
1318 * docutils/parsers/rst/directives/admonitions.py:
1320 - Added "admonition" directive.
1322 * docutils/parsers/rst/directives/body.py: Added to project. Contains
1323 the "topic", "sidebar" (from Patrick O'Brien), "line-block",
1324 "parsed-literal", "rubric", "epigraph", "highlights" and
1325 "pull-quote" directives.
1327 * docutils/parsers/rst/directives/images.py:
1329 - Added an "align" attribute to the "image" & "figure" directives
1330 (by Adam Chodorowski).
1331 - Added "class" option to "image", and "figclass" to "figure".
1333 * docutils/parsers/rst/directives/misc.py:
1335 - Added "include", "raw", and "replace" directives, courtesy of
1337 - Added "unicode" and "class" directives.
1339 * docutils/parsers/rst/directives/parts.py:
1341 - Added the "sectnum" directive; by Dmitry Jemerov.
1342 - Added "class" option to "contents" directive.
1344 * docutils/parsers/rst/directives/references.py: Added to project.
1345 Contains the "target-notes" directive.
1347 * docutils/parsers/rst/languages/__init__.py:
1349 - Return ``None`` from get_language() for missing language modules.
1351 * docutils/parsers/rst/languages/de.py: Added to project; German
1352 mappings by Engelbert Gruber.
1354 * docutils/parsers/rst/languages/en.py:
1356 - Added interpreted text roles mapping.
1358 * docutils/parsers/rst/languages/es.py: Added to project; Spanish
1359 mappings by Marcelo Huerta San Martin.
1361 * docutils/parsers/rst/languages/fr.py: Added to project; French
1362 mappings by William Dode.
1364 * docutils/parsers/rst/languages/it.py: Added to project; Italian
1365 mappings by Nicola Larosa.
1367 * docutils/parsers/rst/languages/sk.py: Added to project; Slovak
1368 mappings by Miroslav Vasko.
1370 * docutils/readers/__init__.py:
1372 - Added support for the observer pattern from ``utils.Reporter``, in
1373 ``Reader.parse`` and ``Reader.transform``.
1374 - Removed ``Reader.transform()`` method.
1375 - Added default parameter values to ``Reader.__init__()`` to make
1376 instantiation easier.
1377 - Removed bogus aliases: "restructuredtext" is *not* a Reader.
1379 * docutils/readers/pep.py:
1381 - Added the ``peps.TargetNotes`` transform to the Reader.
1382 - Removed PEP & RFC reference detection code; moved to
1383 parsers/rst/states.py as options (enabled here by default).
1384 - Added support for pre-acceptance PEPs (no PEP number yet).
1385 - Moved ``Inliner`` & made it a class attribute of ``Reader`` for
1388 * docutils/readers/python: Python Source Reader subpackage added to
1389 project, including preliminary versions of:
1392 - moduleparser.py: Parser for Python modules.
1394 * docutils/transforms/__init__.py:
1396 - Added ``Transformer`` class and completed transform reform.
1397 - Added unknown_reference_resolvers list for each transformer. This list holds
1398 the list of functions provided by each component of the transformer that
1399 help resolve references.
1401 * docutils/transforms/frontmatter.py:
1403 - Improved support for generic fields.
1404 - Fixed bibliographic field language lookups.
1406 * docutils/transforms/misc.py: Added to project. Miscellaneous
1409 * docutils/transforms/parts.py:
1411 - Moved the "id" attribute from TOC list items to the references
1412 (``Contents.build_contents()``).
1413 - Added the ``SectNum`` transform; by Dmitry Jemerov.
1414 - Added "class" attribute support to ``Contents``.
1416 * docutils/transforms/peps.py:
1418 - Added ``mask_email()`` function, updating to pep2html.py's
1420 - Linked "Content-Type: text/x-rst" to PEP 12.
1421 - Added the ``TargetNotes`` PEP-specific transform.
1422 - Added ``TargetNotes.cleanup_callback``.
1423 - Added title check to ``Headers``.
1425 * docutils/transforms/references.py:
1427 - Added the ``TargetNotes`` generic transform.
1428 - Split ``Hyperlinks`` into multiple transforms.
1429 - Fixed bug with multiply-indirect references (report: Bruce Smith).
1430 - Added check for circular indirect references.
1431 - Made substitutions case-sensitive-but-forgiving.
1433 * docutils/transforms/universal.py:
1435 - Added support for the "--expose-internal-attributes" option.
1436 - Removed ``Pending`` transform classes & data.
1438 * docutils/writers/__init__.py:
1440 - Removed ``Writer.transform()`` method.
1442 * docutils/writers/docutils-xml.py:
1444 - Added XML and doctype declarations.
1445 - Added "--no-doctype" and "--no-xml-declaration" options.
1447 * docutils/writers/html4css1.py:
1449 - "name" attributes only on these tags: a, applet, form, frame,
1451 - Added "name" attribute to <a> in section titles for Netscape 4
1452 support (bug report: Pearu Peterson).
1453 - Fixed targets (names) on footnote, citation, topic title,
1454 problematic, and system_message nodes (for Netscape 4).
1455 - Changed field names from "<td>" to "<th>".
1456 - Added "@" to "@" encoding to thwart address harvesters.
1457 - Improved the vertical whitespace optimization; ignore "invisible"
1458 nodes (targets, comments, etc.).
1459 - Improved inline literals with ``<span class="pre">`` around chunks
1460 of text and `` `` for runs of spaces.
1461 - Improved modularity of output; added ``self.body_pre_docinfo`` and
1462 ``self.docinfo`` segments.
1463 - Added support for "line_block", "address" elements.
1464 - Improved backlinks (footnotes & system_messages).
1465 - Improved system_message output.
1466 - Redefined "--stylesheet" as containing an invariant URL, used
1467 verbatim. Added "--stylesheet-path", interpreted w.r.t. the
1469 - Added "--footnote-references" option (superscript or brackets).
1470 - Added "--compact-lists" and "--no-compact-lists" options.
1471 - Added "--embed-stylesheet" and "--link-stylesheet" options;
1472 factored out ``HTMLTranslator.get_stylesheet_reference()``.
1473 - Improved field list rendering.
1474 - Added Docutils version to "generator" meta tag.
1475 - Fixed a bug with images; they must be inline, so wrapped in <p>.
1476 - Improved layout of <pre> HTML source.
1477 - Fixed attribute typo on <colspec>.
1478 - Refined XML prologue.
1479 - Support for no stylesheet.
1480 - Removed "interpreted" element support.
1481 - Added support for "title_reference", "sidebar", "attribution",
1482 "rubric", and generic "admonition" elements.
1483 - Added "--attribution" option.
1484 - Added support for "inline", "subscript", "superscript" elements.
1485 - Added initial support for "abbreviation" and "acronym";
1488 * docutils/writers/latex2e.py: LaTeX Writer, added by Engelbert Gruber
1492 - Double quotes in literal blocks (special treatment for de/ngerman).
1493 - Added '--hyperlink-color' option ('0' turns off coloring of links).
1494 - Added "--attribution" option.
1495 - Right align attributions.
1497 * docutils/writers/pep_html.py:
1499 - Parameterized output encoding in PEP template.
1500 - Reworked substitutions from ``locals()`` into ``subs`` dict.
1501 - Redefined "--pep-stylesheet" as containing an invariant URL, used
1502 verbatim. Added "--pep-stylesheet-path", interpreted w.r.t. the
1504 - Added an override on the "--footnote-references" option.
1505 - Factored out ``HTMLTranslator.get_stylesheet_reference()``.
1506 - Added Docutils version to "generator" meta tag.
1507 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1511 - Added a "silent" setting for ``buildhtml.py``.
1512 - Added a "Getting Help" section.
1513 - Rearranged the structure.
1514 - Kept up to date, with new settings, command-line options etc.
1515 - Added section for ``rst2latex.py`` (Engelbert Gruber).
1516 - Converted settings table into a definition list.
1518 * docs/rst/quickstart.txt:
1520 - Added a table of contents.
1521 - Added feedback information.
1522 - Added mention of minimum section title underline lengths.
1523 - Removed the 4-character minimum for section title underlines.
1525 * docs/rst/quickref.html:
1527 - Added a "Getting Help" section.
1528 - Added a style to make section title backlinks more subtle.
1529 - Added mention of minimum section title underline lengths.
1530 - Removed the 4-character minimum for section title underlines.
1532 * extras: Directory added to project; contains third-party modules
1533 that Docutils depends on (optparse, textwrap, roman). These are
1534 only installed if they're not already present.
1536 * licenses: Directory added to project; contains copies of license
1537 files for non-public-domain files.
1541 - Changed the focus. It's about DTD elements: structural
1542 relationships, semantics, and external (public) attributes. Not
1543 about the element class library.
1544 - Moved some implementation-specific stuff into ``docutils.nodes``
1546 - Wrote descriptions of all common attributes and parameter
1547 entities. Filled in introductory material.
1548 - Working through the element descriptions: 55 down, 37 to go.
1549 - Removed "Representation of Horizontal Rules" to
1550 spec/rst/alternatives.txt.
1552 * spec/docutils.dtd:
1554 - Added "generated" inline element.
1555 - Added "line_block" body element.
1556 - Added "auto" attribute to "title".
1557 - Changed content models of "literal_block" and "doctest_block" to
1559 - Added ``%number;`` attribute type parameter entity.
1560 - Changed ``%structural.elements;`` to ``%section.elements``.
1561 - Updated attribute types; made more specific.
1562 - Added "address" bibliographic element.
1563 - Added "line" attribute to ``system_message`` element.
1564 - Removed "field_argument" element; "field_name" may contain
1565 multiple words and whitespace.
1566 - Changed public identifier to docutils.sf.net.
1567 - Removed "interpreted" element; added "title_reference",
1568 "abbreviation", "acronym".
1569 - Removed "refuri" attribute from "footnote_reference" and
1570 "citation_reference".
1571 - Added "sidebar", "rubric", "attribution", "admonition",
1572 "superscript", "subscript", and "inline" elements.
1574 * spec/pep-0256.txt: Converted to reStructuredText & updated.
1576 * spec/pep-0257.txt: Converted to reStructuredText & updated.
1578 * spec/pep-0258.txt: Converted to reStructuredText & updated.
1580 * spec/semantics.txt: Updated with text from a Doc-SIG response to
1583 * spec/transforms.txt: Added to project.
1585 * spec/howto: Added subdirectory, for developer how-to docs.
1587 * spec/howto/rst-directives.txt: Added to project. Original by Dethe
1588 Elza, edited & extended by David Goodger.
1590 * spec/howto/i18n.txt: Docutils Internationalization. Added to
1593 * spec/rst/alternatives.txt:
1595 - Added "Doctree Representation of Transitions" from
1597 - Updated "Inline External Targets" & closed the debate.
1598 - Added ideas for interpreted text syntax extensions.
1599 - Added "Nested Inline Markup" section.
1601 * spec/rst/directives.txt:
1603 - Added directives: "topic", "sectnum", "target-notes",
1604 "line-block", "parsed-literal", "include", "replace", "sidebar",
1605 "admonition", "rubric", "epigraph", "highlights", "unicode" and
1607 - Formalized descriptions of directive details.
1608 - Added an "align" attribute to the "image" & "figure" directives
1609 (by Adam Chodorowski).
1610 - Added "class" options to "topic", "sidebar", "line-block",
1611 "parsed-literal", "contents", and "image"; and "figclass" to
1614 * spec/rst/interpreted.txt: Added to project. Descriptions of
1615 interpreted text roles.
1617 * spec/rst/introduction.txt:
1619 - Added pointers to material for new users.
1621 * spec/rst/reStructuredText.txt:
1623 - Disambiguated comments (just add a newline after the "::").
1624 - Updated enumerated list description; added a discussion of the
1625 second-line validity checking.
1626 - Updated directive description.
1627 - Added a note redirecting newbies to the user docs.
1628 - Expanded description of inline markup start-strings in non-markup
1630 - Removed field arguments and made field lists a generic construct.
1631 - Removed the 4-character minimum for section title underlines.
1632 - Clarified term/classifier delimiter & inline markup ambiguity
1634 - Added "Embedded URIs".
1635 - Updated "Interpreted Text" section.
1636 - Added "Character-Level Inline Markup" section.
1638 * test: Continually adding & updating tests.
1640 - Moved test/test_rst/ to test/test_parsers/test_rst/.
1641 - Moved test/test_pep/ to test/test_readers/test_pep/.
1642 - Added test/test_readers/test_python/.
1643 - Added test/test_writers/ (Engelbert Gruber).
1647 - Made the ``locale.setlocale()`` calls in front ends
1650 * tools/buildhtml.py:
1652 - Added "--silent" option.
1653 - Fixed bug with absolute paths & "--config".
1654 - Updated for new I/O classes.
1655 - Added some exception handling.
1656 - Separated publishers' setting defaults; prevents interference.
1657 - Updated for new ``publish_file()`` convenience function.
1659 * tools/pep-html-template:
1661 - Allow for "--embed-stylesheet".
1662 - Added Docutils version to "generator" meta tag.
1663 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1664 - Conform to XHTML spec.
1666 * tools/pep2html.py:
1668 - Made ``argv`` a parameter to ``main()``.
1669 - Added support for "Content-Type:" header & arbitrary PEP formats.
1670 - Linked "Content-Type: text/plain" to PEP 9.
1671 - Files skipped (due to an error) are not pushed onto the server.
1672 - Updated for new I/O classes.
1673 - Added ``check_requirements()`` & ``pep_type_error()``.
1674 - Added some exception handling.
1675 - Updated for new ``publish_string()`` convenience function.
1676 - Added a "DO NOT EDIT THIS FILE" comment to generated HTML.
1678 * tools/quicktest.py:
1680 - Added "-V"/"--version" option.
1682 * tools/rst2latex.py: LaTeX front end, added by Engelbert Gruber.
1684 * tools/unicode2rstsubs.py: Added to project. Produces character
1685 entity files (reSructuredText substitutions) from the MathML master
1688 * tools/editors: Support code for editors, added to project. Contains
1689 ``emacs/restructuredtext.el``.
1691 * tools/stylesheets/default.css: Moved into the stylesheets directory.
1693 - Added style for chunks of inline literals.
1694 - Removed margin for first child of table cells.
1695 - Right-aligned field list names.
1696 - Support for auto-numbered section titles in TOCs.
1697 - Increased the size of inline literals (<tt>) in titles.
1698 - Restored the light gray background for inline literals.
1699 - Added support for "line_block" elements.
1700 - Added style for "address" elements.
1701 - Removed "a.footnote-reference" style; doing it with ``<sup>`` now.
1702 - Improved field list rendering.
1703 - Vertical whitespace improvements.
1704 - Removed "a.target" style.
1706 * tools/stylesheets/pep.css:
1708 - Fixed nested section margins.
1709 - Other changes parallel those of ``../default.css``.
1712 Release 0.2 (2002-07-31)
1713 ========================
1717 - The word "component" was being used ambiguously. From now on,
1718 "component" will be used to mean "Docutils component", as in Reader,
1719 Writer, Parser, or Transform. Portions of documents (Table of
1720 Contents, sections, etc.) will be called "document parts".
1721 - Did a grand renaming: a lot of ``verylongnames`` became
1722 ``very_long_names``.
1723 - Cleaned up imports: no more relative package imports or
1724 comma-separated lists of top-level modules.
1725 - Added support for an option values object which carries default
1726 settings and overrides (from command-line options and library use).
1727 - Added internal Unicode support, and support for both input and
1729 - Added support for the ``docutils.io.IO`` class & subclasses.
1733 * docutils/__init__.py:
1735 - Added ``ApplicationError`` and ``DataError``, for use throughout
1737 - Added ``Component`` base class for Docutils components; implements
1738 the ``supports`` method.
1739 - Added ``__version__`` (thus, ``docutils.__version__``).
1743 - Removed many keyword parameters to ``Publisher.__init__()`` and
1744 ``publish()``; bundled into an option values object. Added
1745 "argv", "usage", "description", and "option_spec" parameters for
1746 command-line support.
1747 - Added ``Publisher.process_command_line()`` and ``.set_options()``
1749 - Reworked I/O model for ``docutils.io`` wrappers.
1750 - Updated ``Publisher.set_options()``; now returns option values
1752 - Added support for configuration files (/etc/docutils.conf,
1753 ./docutils.conf, ~/.docutils).
1754 - Added ``Publisher.setup_option_parser()``.
1755 - Added default usage message and description.
1757 * docutils/frontend.py: Added to project; support for front-end
1758 (command-line) scripts. Option specifications may be augmented by
1759 components. Requires Optik (http://optik.sf.net/) for option
1760 processing (installed locally as docutils/optik.py).
1762 * docutils/io.py: Added to project; uniform API for a variety of input
1765 * docutils/nodes.py:
1767 - Added ``TreeCopyVisitor`` class.
1768 - Added a ``copy`` method to ``Node`` and subclasses.
1769 - Added a ``SkipDeparture`` exception for visitors.
1770 - Renamed ``TreePruningException`` from ``VisitorException``.
1771 - Added docstrings to ``TreePruningException``, subclasses, and
1773 - Improved docstrings.
1774 - Added ``SparseNodeVisitor``, refined ``NodeVisitor``.
1775 - Moved ``utils.id()`` to ``nodes.make_id()`` to avoid circular
1777 - Added ``decoration``, ``header``, and ``footer`` node classes, and
1778 ``PreDecorative`` mixin.
1779 - Reworked the name/id bookkeeping; to ``document``, removed
1780 ``explicit_targets`` and ``implicit_targets`` attributes, added
1781 ``nametypes`` attribute and ``set_name_id_map`` method.
1782 - Added ``NodeFound`` exception, for use with ``NodeVisitor``
1784 - Added ``document.has_name()`` method.
1785 - Fixed DOM generation for list-attributes.
1786 - Added category class ``Labeled`` (used by footnotes & citations).
1787 - Added ``Element.set_class()`` method (sets "class" attribute).
1789 * docutils/optik.py: Added to project. Combined from the Optik
1790 package, with added option groups and other modifications. The use
1791 of this module is probably only temporary.
1793 * docutils/statemachine.py:
1795 - Added ``runtime_init`` method to ``StateMachine`` and ``State``.
1796 - Added underscores to improve many awkward names.
1797 - In ``string2lines()``, changed whitespace normalizing translation
1798 table to regexp; restores Python 2.0 compatibility with Unicode.
1800 * docutils/urischemes.py:
1802 - Filled in some descriptions.
1803 - Added "shttp" scheme.
1805 * docutils/utils.py:
1807 - Added ``clean_rcs_keywords`` function (moved from
1808 docutils/transforms/frontmatter.py
1809 ``DocInfo.filter_rcs_keywords``).
1810 - Added underscores to improve many awkward names.
1811 - Changed names of Reporter's thresholds:
1812 warning_level -> report_level; error_level -> halt_level.
1813 - Moved ``utils.id()`` to ``nodes.make_id()``.
1814 - Added ``relative_path(source, target)``.
1816 * docutils/languages/de.py: German mappings; added to project. Thanks
1817 to Gunnar Schwant for the translations.
1819 * docutils/languages/en.py: Added "Dedication" bibliographic field
1822 * docutils/languages/sv.py: Swedish mappings; added to project by Adam
1825 * docutils/parsers/rst/states.py:
1827 - Added underscores to improve many awkward names.
1828 - Added RFC-2822 header support.
1829 - Extracted the inline parsing code from ``RSTState`` to a separate
1830 class, ``Inliner``, which will allow easy subclassing.
1831 - Made local bindings for ``memo`` container & often-used contents
1832 (reduces code complexity a lot). See ``RSTState.runtime_init()``.
1833 - ``RSTState.parent`` replaces ``RSTState.statemachine.node``.
1834 - Added ``MarkupMismatch`` exception; for late corrections.
1835 - Added ``-/:`` characters to inline markup's start string prefix,
1836 ``/`` to end string suffix.
1837 - Fixed a footnote bug.
1838 - Fixed a bug with literal blocks.
1839 - Applied patch from Simon Budig: simplified regexps with symbolic
1840 names, removed ``Inliner.groups`` and ``Body.explicit.groups``.
1841 - Converted regexps from ``'%s' % var`` to ``'%(var)s' % locals()``.
1842 - Fixed a bug in ``Inliner.interpreted_or_phrase_ref()``.
1843 - Allowed non-ASCII in "simple names" (directive names, field names,
1845 - Converted ``Inliner.patterns.initial`` to be dynamically built
1846 from parts with ``build_regexp()`` function.
1847 - Changed ``Inliner.inline_target`` to ``.inline_internal_target``.
1848 - Updated docstrings.
1849 - Changed "table" to "grid_table"; added "simple_table" support.
1851 * docutils/parsers/rst/tableparser.py:
1853 - Changed ``TableParser`` to ``GridTableParser``.
1854 - Added ``SimpleTableParser``.
1855 - Refactored naming.
1857 * docutils/parsers/rst/directives/__init__.py: Added "en" (English) as
1858 a fallback language for directive names.
1860 * docutils/parsers/rst/directives/html.py: Changed the ``meta``
1861 directive to use a ``pending`` element, used only by HTML writers.
1863 * docutils/parsers/rst/directives/parts.py: Renamed from
1866 - Added "backlinks" attribute to "contents" directive.
1868 * docutils/parsers/rst/languages/sv.py: Swedish mappings; added to
1869 project by Adam Chodorowski.
1871 * docutils/readers/__init__.py: Gave Readers more control over
1872 choosing and instantiating Parsers.
1874 * docutils/readers/pep.py: Added to project; for PEP processing.
1876 * docutils/transforms/__init__.py: ``Transform.__init__()`` now
1877 requires a ``component`` parameter.
1879 * docutils/transforms/components.py: Added to project; transforms
1880 related to Docutils components.
1882 * docutils/transforms/frontmatter.py:
1884 - In ``DocInfo.extract_authors``, check for a single "author" in an
1885 "authors" group, and convert it to a single "author" element.
1886 - Added support for "Dedication" and generic bibliographic fields.
1888 * docutils/transforms/peps.py: Added to project; PEP-specific.
1890 * docutils/transforms/parts.py: Renamed from old components.py.
1892 - Added filter for `Contents`, to use alt-text for inline images,
1893 and to remove inline markup that doesn't make sense in the ToC.
1894 - Added "name" attribute to TOC topic depending on its title.
1895 - Added support for optional TOC backlinks.
1897 * docutils/transforms/references.py: Fixed indirect target resolution
1898 in ``Hyperlinks`` transform.
1900 * docutils/transforms/universal.py:
1902 - Changed ``Messages`` transform to properly filter out system
1903 messages below the warning threshold.
1904 - Added ``Decorations`` transform (support for ``--generator``,
1905 ``--date``, ``--time``, ``--source-link`` options).
1907 * docutils/writers/__init__.py: Added "pdf" alias in anticipation of
1908 Engelbert Gruber's PDF writer.
1910 * docutils/writers/html4css1.py:
1912 - Made XHTML-compatible (switched to lowercase element & attribute
1913 names; empty tag format).
1914 - Escape double-dashes in comment text.
1915 - Improved boilerplate & modularity of output.
1916 - Exposed modular output in Writer class.
1917 - Added a "generator" meta tag to <head>.
1918 - Added support for the ``--stylesheet`` option.
1919 - Added support for ``decoration``, ``header``, and ``footer``
1921 - In ``HTMLTranslator.attval()``, changed whitespace normalizing
1922 translation table to regexp; restores Python 2.0 compatibility
1924 - Added the translator class as instance variable to the Writer, to
1925 make it easily subclassable.
1926 - Improved option list spacing (thanks to Richard Jones).
1927 - Modified field list output.
1928 - Added backlinks to footnotes & citations.
1929 - Added percentage widths to "<col>" tags (from colspec).
1930 - Option lists: "<code>" changed to "<kbd>", ``option_argument``
1931 "<span>" changed to "<var>".
1932 - Inline literals: "<code>" changed to "<tt>".
1933 - Many changes to optimize vertical space: compact simple lists etc.
1934 - Add a command-line options & directive attributes to control TOC
1935 and footnote/citation backlinks.
1936 - Added support for optional footnote/citation backlinks.
1937 - Added support for generic bibliographic fields.
1938 - Identify backrefs.
1939 - Relative URLs for stylesheet links.
1941 * docutils/writers/pep_html.py: Added to project; HTML Writer for
1942 PEPs (subclass of ``html4css1.Writer``).
1944 * docutils/writers/pseudoxml.py: Renamed from pprint.py.
1946 * docutils/writers/docutils_xml.py: Added to project; trivial writer
1947 of the Docutils internal doctree in XML.
1949 * docs/tools.txt: "Docutils Front-End Tools", added to project.
1953 - Changed the title to "The Docutils Document Tree".
1954 - Added "Hyperlink Bookkeeping" section.
1956 * spec/docutils.dtd:
1958 - Added ``decoration``, ``header``, and ``footer`` elements.
1959 - Brought ``interpreted`` element in line with the parser: changed
1960 attribute "type" to "role", added "position".
1961 - Added support for generic bibliographic fields.
1963 * spec/notes.txt: Continual updates. Added "Project Policies".
1965 * spec/pep-0256.txt: Updated. Added "Roadmap to the Doctring PEPs"
1968 * spec/pep-0257.txt: Clarified prohibition of signature repetition.
1970 * spec/pep-0258.txt: Updated. Added text from pysource.txt and
1971 mailing list discussions.
1973 * spec/pep-0287.txt:
1975 - Renamed to "reStructuredText Docstring Format".
1977 - Reworked Q&A as an enumerated list.
1978 - Converted to reStructuredText format.
1980 * spec/pysource.dtd:
1982 - Reworked structural elements, incorporating ideas from Tony Ibbs.
1984 * spec/pysource.txt: Removed from project. Moved much of its contents
1987 * spec/rst/alternatives.txt:
1989 - Expanded auto-enumerated list idea; thanks to Fred Bremmer.
1990 - Added "Inline External Targets" section.
1992 * spec/rst/directives.txt:
1994 - Added "backlinks" attribute to "contents" directive.
1996 * spec/rst/problems.txt:
1998 - Updated the Enumerated List Markup discussion.
1999 - Added new alternative table markup syntaxes.
2001 * spec/rst/reStructuredText.txt:
2003 - Clarified field list usage.
2004 - Updated enumerated list description.
2005 - Clarified purpose of directives.
2006 - Added ``-/:`` characters to inline markup's start string prefix,
2007 ``/`` to end string suffix.
2008 - Updated "Authors" bibliographic field behavior.
2009 - Changed "inline hyperlink targets" to "inline internal targets".
2010 - Added "simple table" syntax to supplement the existing but
2011 newly-renamed "grid tables".
2012 - Added cautions for anonymous hyperlink use.
2013 - Added "Dedication" and generic bibliographic fields.
2015 * test: Made test modules standalone (subdirectories became packages).
2017 * test/DocutilsTestSupport.py:
2019 - Added support for PEP extensions to reStructuredText.
2020 - Added support for simple tables.
2021 - Refactored naming.
2023 * test/package_unittest.py: Renamed from UnitTestFolder.py.
2025 - Now supports true packages containing test modules
2026 (``__init__.py`` files required); fixes duplicate module name bug.
2028 * test/test_pep/: Subpackage added to project; PEP testing.
2030 * test/test_rst/test_SimpleTableParser.py: Added to project.
2034 - Updated html.py and publish.py front-end tools to use the new
2035 command-line processing facilities of ``docutils.frontend``
2036 (exposed in ``docutils.core.Publisher``), reducing each to just a
2038 - Added ``locale.setlocale()`` calls to front-end tools.
2040 * tools/buildhtml.py: Added to project; batch-generates .html from all
2041 the .txt files in directories and subdirectories.
2043 * tools/default.css:
2045 - Added support for ``header`` and ``footer`` elements.
2046 - Added styles for "Dedication" topics (biblio fields).
2048 * tools/docutils.conf: A configuration file; added to project.
2050 * tools/docutils-xml.py: Added to project.
2052 * tools/pep.py: Added to project; PEP to HTML front-end tool.
2054 * tools/pep-html-template: Added to project.
2056 * tools/pep2html.py: Added to project from Python (nondist/peps).
2057 Added support for Docutils (reStructuredText PEPs).
2059 * tools/quicktest.py:
2061 - Added the ``--attributes`` option, hacked a bit.
2062 - Added a second command-line argument (output file); cleaned up.
2064 * tools/stylesheets/: Subdirectory added to project.
2066 * tools/stylesheets/pep.css: Added to project; stylesheet for PEPs.
2069 Release 0.1 (2002-04-20)
2070 ========================
2072 This is the first release of Docutils, merged from the now inactive
2073 reStructuredText__ and `Docstring Processing System`__ projects. For
2074 the pre-Docutils history, see the `reStructuredText HISTORY`__ and the
2075 `DPS HISTORY`__ files.
2077 __ http://structuredtext.sourceforge.net/
2078 __ http://docstring.sourceforge.net/
2079 __ http://structuredtext.sourceforge.net/HISTORY.html
2080 __ http://docstring.sourceforge.net/HISTORY.html
2082 General changes: renamed 'dps' package to 'docutils'; renamed
2083 'restructuredtext' subpackage to 'rst'; merged the codebases; merged
2084 the test suites (reStructuredText's test/test_states renamed to
2085 test/test_rst); and all modifications required to make it all work.
2087 * docutils/parsers/rst/states.py:
2089 - Improved diagnostic system messages for missing blank lines.
2090 - Fixed substitution_reference bug.
2096 indent-tabs-mode: nil
2097 sentence-end-double-space: t