更新历史¶
- Author
David Goodger; open to all Docutils developers
- Contact
- Date
$Date: 2018-07-12 12:17:15 +0200 (Do, 12. Jul 2018) $
- Revision
$Revision: 8224 $
- 网站
- 版权
本文档已置于公共领域。
目录
自0.14以来的变化¶
一般
不再支持Python 2.4,2.5,3.1和3.2。
基建自动化。
docs/ref/rst/restructuredtext.txt:
Document rST syntax change: Tokens like
:this:example:
are now valid field list names (instead of ordinary text).
docutils/nodes.py
Fix [ 251 ] system_message.copy() TypeError.
Element.copy() also copies document, line, and source attributes.
docutils/parsers/rst/states.py:
允许在字段列表字段名称中嵌入冒号。
Add rawsource attribute for text of inline elements and definition list terms.
Fix: definition list term classifier starting with a reference crash.
docutils/parsers/rst/directives/html.py:
Fix bug #281: Remove escaping backslashes in meta directive content.
docutils/parsers/rst/directives/tables.py:
Apply patch #121: Add “width” option for the table directives.
docutils/transforms/frontmatter.py:
Add field name as class argument to generic docinfo fields unconditionally.
Ignore backslash-escaped separators when extracting authors from a paragraph.
docutils/transforms/references.py:
Fix bug #331: fixed the “trim” options of the “unicode” directive.
docutils/utils/smartquotes.py:
Fix bug #332: use open quote after whitespace, ZWSP, and ZWNJ.
docutils/writers/html5_polyglot/
automatically add HTML5-compatible meta tags for docinfo items “authors”, “date”, and “copyright”.
docutils/writers/latex2e/__init__.py:
Fix bug #323: spurious
\phantomsection
and whitespace inparts['title']
.Fix bug #324: Invalid LaTeX for table with empty multicolumn cell.
Fixes to literal block handling.
docutils/utils/__init__.py:
Deprecate unique_combinations (obsoleted by itertools.combinations).
New function unescape_rawsource.
Release 0.14 (2017-08-03)¶
docs/ref/docutils.dtd:
Enable validation of Docutils XML documents against the DTD:
Use attribute type NMTOKEN instead of REFID for the refid attribute and NMTOKENS for backrefs: REFID refers to an ID type instance, however, the ids attribute cannot use the ID type because XML only allows one ID per Element Type and doesn’t support a multiple-ID “IDS” attribute type.
docs/ref/rst/restructuredtext.txt:
Added documentation for escaped whitespace in URI contexts.
Clarify use of Unicode character categories.
docutils/parsers/rst/states.py:
Added functionality: escaped whitespace in URI contexts.
Consistent handling of all whitespace characters in inline markup recognition. Fixes [ 307 ] and [ 3402314 ] (now [ 173 ]).
docutils/parsers/rst/directives/images.py:
Added support for escaped whitespace in URI contexts.
docutils/parsers/rst/directives/tables.py:
Rework patch [ 120 ] (revert change to
Table.get_column_widths()
that led to problems in an application with a custom table directive).
docutils/transforms/frontmatter.py:
Fix [ 320 ] Russian docinfo fields not recognized.
docutils/transforms/references.py:
Don’t add a second ID to problematic references.
docutils/transforms/universal.py:
Fix SmartQuotes: warn only once if language is unsupported, keep “rawsource” when “educating” quotes.
docutils/utils/__init__.py:
Added
split_escaped_whitespace
function, support for escaped whitespace in URI contexts.
docutils/utils/error_reporting.py:
Fix [ 321 ] Import block might cause name error.
docutils/utils/smartquotes.py:
Update quote definitions for languages et, fi, fr, ro, sv, tr, uk.
New quote definitions for hr, hsb, hu, lv, sh, sl, sr.
Fix [ 313 ] Differentiate apostrophe from closing single quote (if possible).
Fix [ 317 ] Extra space inserted with French smartquotes.
Add command line interface for stand-alone use (requires 2.7).
docutils/writers/_html_base.py:
Provide default title in metadata (required by HTML5).
Fix [ 312 ] HTML writer generates invalid HTML if the table has two tags.
Fix [ 319 ] The MathJax CDN shut down on April 30, 2017. For security reasons, we don’t use a third party public installation as default but warn if math-output is set to MathJax without specifying a URL.
docutils/writers/html4css1/__init__.py:
Apply [ 125 ] HTML writer: respect automatic table column sizing.
docutils/writers/latex2e/__init__.py:
Handle class arguments for block-level elements by wrapping them in a “DUclass” environment. This replaces the special handling for “epigraph” and “topic” elements.
docutils/writers/manpage.py:
Apply [ 141 ] Handling inline in manpage writer.
docutils/writers/odf_odt/__init__.py:
Command setting
language
now sets the default language of the generated ODF document.The use of image directive options :width: (%), :scale:, etc now set the width/height/size of images in the generated ODF documents.
The heading/title of admonitions now reflects the language specified by the
language
setting.Fixed [ 306 ] only first of multiple “image” directives with the same URL shown in output.
Fixed [ 282 ] python3: AttributeError.
tools/rst2html4.py: New front-end.
tools/dev/generate_punctuation_chars.py: New skript to test and update utils.punctuation_chars.
Release 0.13.1 (2016-12-09)¶
docutils/languages/fa.py docutils/parsers/rst/languages/fa.py docutils/languages/la.py docutils/parsers/rst/languages/la.py:
Apply [ 133 ] Persian mappings by Shahin Azad.
Apply [ 135 ] Language modules for Latvian by Alexander Smishlajev
docutils/nodes.py
Fix [ 253 ] Attribute key without value not allowed in XML.
docutils/parsers/
Apply [ 103 ] Recognize inline markups without word boundaries.
Enable escaping in embedded URIs and aliases (fixes [ 284 ]).
docutils/parsers/rst/__init__.py
Fix [ 233 ] Change the base URL for the :rfc: role.
docutils/parsers/rst/directives/tables.py
Apply [ 120 ] tables accept option widths: list of relative widths, ‘auto’ or ‘grid’.
Implement feature request [ 48 ] Add :align: option to the table directives. Thanks to Takeshi KOMIYA for the patch.
docutils/parsers/rst/roles.py
Fix [ 295 ] Class argument for custom role inheriting from math.
docutils/parsers/rst/tableparser.py
Really fix [ 159 ] Spurious table column alignment errors.
docutils/transforms/frontmatter.py
Add name of generic bibliographic fields as a “classes” attribute value (after conversion to a valid identifier form).
docutils/utils/error_reporting.py
Fix [ 130 ] support streams expectiong byte-strings in ErrorOutput.
docutils/utils/math/math2html.py
Add
\colon
macro, fix spacing around colons. Fixes [ 246 ].New upstream version (additional macros, piecewise integrals and sums).
docutils/writers/_html_base.py
New auxiliary module for definitions common to all HTML writers.
docutils/writers/html5_polyglot/
docutils/writers/html4css1/__init__.py
Add “docutils” to class values for “container” object to address [ 267 ].
Apply patch [ 119 ] by Anatoly Techtonik: use absolute paths for
default_stylesheet_path
anddefault_template_path
.Fix [ 266 ] creating labels/class values in description list items.
Do not use <sup> and <sub> tags inside <pre> (parsed-literal blocks).
Fix footnotes with content that does not start with a paragraph.
Use https in default MathJax URL (report Alan G Isaac).
Outsourcing of common code to _html_base.py.
docutils/writers/latex2e/__init__.py
Fix [ 262 ] Use
\linewidth
instead of\textwidth
for figures, admonitions and docinfo.Use absolute path for
default_template_path
.Removed deprecated options
--use-latex-footnotes
and--figure-footnotes
.Cleaner LaTeX code for enumerations and literal blocks.
Use “hyperref” package together with “bookmark” (improved hyperlinking by the same author).
Fix [ 286 ] Empty column title cause invalid latex file.
Fix [ 224 ] Fix rowspan support for tables.
Let LaTeX determine the column widths in tables with “colwidths-auto”. Not suited for multi-paragraph cells!
docutils/writers/odf_odt/__init__.py
remove decode.encode of filename stored in zip.
docutils/writers/xetex/__init__.py
LuaLaTex compatibility: do not load “xunicode”.
tools/
New front-end
rst2html5.py
.
tox.ini
Test py26, py27, py33 and py34.
To use, install the
tox
package via pip or easy_install and use tox from the project root directory.
Release 0.12 (2014-07-06)¶
docs/ref/rst/directives.txt
Update “math” and “csv-table” descriptions.
docutils/parsers/rst/directives/images.py
Fix [ 258 ] figwidth=”image” generates unitless width value.
docutils/parsers/rst/states.py
Improve error report when a non-ASCII character is specified as delimiter, quote or escape character under Python 2. Fixes [ 249 ] and [ 250 ].
docutils/writers/html4css1/__init__.py
Don’t add newline after inline math. Thanks to Yury G. Kudryashov for the patch.
docutils/writers/latex2e/__init__.py
Fix [ 239 ] Latex writer glues paragraphs with figure floats.
Apply [ 116 ] by Kirill Smelkov. Don’t hardcode large for subtitle.
docutils/writers/odf_odt/__init__.py
Apply patch by Jakub Wilk to fix bug [ 100 ].
test/test_error_reporting.py
Fix [ 223 ] by removing redundant tests we do not have control over.
test/test_nodes.py
Apply [ 115 ] respect fixed 2to3 string literal conversion behavior.
Release 0.11 (2013-07-22)¶
一般
Apply [ 2714873 ] Fix for the overwritting of document attributes.
Support embedded aliases within hyperlink references.
Fix [ 228 ] try local import of docutils components (reader, writer, parser, language module) before global search.
docutils/nodes.py
Fix [ 3601607 ] node.__repr__() must return str instance.
docutils/parsers/rst/directives/__init__.py
Fix [ 3606028 ]
assert
is skipped withpython -O
.
docutils/parsers/rst/directives/images.py
Apply [ 3599485 ] node source/line information for sphinx translation.
docutils/parsers/rst/directives/tables.py
Fix [ 210 ] Python 3.3 checks CVS syntax only if “strict” is True.
docutils/parsers/rst/states.py
Fix [ 157 ] Line block parsing doesn’t like system message.
Always import our local copy of roman.py (report Larry Hastings).
docutils/transforms/references.py
Fix [ 3607029 ] traceback with embedded alias pointing to missing target.
docutils/utils/__init__.py
Fix [ 3596884 ] exception importing
docutils.io
.
docutils/writers/html4css1/__init__.py
Fix [ 3600051 ] for tables in a list, table cells are not compacted.
New setting stylesheet_dirs: Comma-separated list of directories where stylesheets are found. Used by stylesheet_path when expanding relative path arguments.
New default for math-output:
HTML math.css
.Avoid repeated class declarations in html4css1 writer (modified version of patch [ 104 ]).
docutils/writers/latex2e/__init__.py
Drop the simple algorithm replacing straight double quotes with English typographic ones. Activate the SmartQuotes transform if you want this feature.
Fix literal use of babel shorthands (straight quote, tilde, …).
Fix [ 3603246 ] Bug in option “–graphicx-option=auto”.
New setting stylesheet_dirs.
docutils/writers/manpage.py
Fix [3607063] handle lines starting with a period.
Fix option separating comma was bold (thanks to Bill Morris).
Release 0.10 (2012-12-16)¶
一般
Dropped support for Python 2.3.
docutils/math
,docutils/error_reporting.py
, anddocutils/urischemes.py
moved to the utils package.Fix [3541369] Relative __import__ also with Python 3.3.
Fix [3559988] and [3560841] __import__ local writer, reader, languages and parsers for Python 2.7 up.
Fix import of PIL.Image.
Change default of “syntax highlight” option to “long”, basic syntax highlight styles for LaTeX and HTML.
docutils/io.py
FileInput/FileOutput: no system-exit on IOError. The handle_io_errors option is ignored and will be removed in a future release.
Fix Py3k error writing to stdout with encoding differing from default.
Fix opening binary files under Py3k (thanks to Dominic Fitzpatrick).
docutils/parsers/rst/directives/misc.py
Fix [ 3546533 ] Unicode error with date directive.
docutils/transforms/universal.py
SmartQuotes transform for typographic quotes and dashes.
docutils/utils/__init__.py
normalize_language_tag() now returns BCP 47 conformant tags with subtags separated by
-
.
docutils/writers/html4css1/__init__.py
Use
<code>
tag for inline “code”, do not drop nested inline nodes (syntax highlight tokens).Customizable MathJax URL (based on patch by Dmitry Shachnev).
No line break after opening inline math tag.
docutils/writers/manpage.py
Apply [ 3527401 ] addmonition’s don’t preserve indentation
Apply [ 3527397 ] Add indentation to literal blocks in manpage writer.
docutils/writers/xetex/__init__.py
Apply [ 3555160 ] ensure order of “otherlanguages”.
Fix section numbering by LaTeX.
docutils/writers/s5_html/__init__.py
Fix [ 3556388 ] Mathjax does not work with rst2s5.
docutils/writers/s5_html/docutils_xml.py
Fix [ 3552403 ] Prevent broken PyXML replacing stdlibs xml module.
Fix/improve output with
--indent
option.
setup.py
Tag
math.css
stylesheet as data file (patch by Dmitry Shachnev).
tools/test/test_buildhtml.py
Fix [ 3521167 ] allow running in any directory.
Fix [ 3521168 ] allow running with Python 3.
Release 0.9.1 (2012-06-17)¶
setup.py
Fix [ 3527842 ]. Under Python聽3, converted tests and tools were installed in the PYTHONPATH. Converted tests are now stored in
test3/
, tools no longer need conversion.If you installed one of Docutils versions 0.7 … 0.9 with
setup.py install
under Python聽3, remove the spurioustest/
andtools/
directories in the site library root.
test/
Make tests independent from the location of the
test/
directory.Use converted sources (from the
build/
directory) for tests under Python聽3.
tools/
Make tools compatible with both, Python 2 and 3 without 2to3-conversion.
docutils/io.py
Fix writing binary data to sys.stdout under Python聽3 (allows
rst2odt.py
to be used with output redirection).
docutils/parsers/rst/directives/misc.py
Fix [ 3525847 ]. Catch and report UnicodeEncodeError with
locale == C
and 8-bit char in path argument of include directive.
test/alltests.py
class Tee: catch UnicodeError when writing to “ascii” stream or file under Python聽3.
Release 0.9 (2012-05-02)¶
General:
New reStructuredText “code” role and directive and “code” option of the “include” directive with syntax highlighting by Pygments.
Fix parse_option_marker for option arguments containing
=
.Fix [ 2993756 ]: import Python Imaging Library’s Image module via
import PIL
as starting with PIL 1.2, “PIL lives in the PIL namespace only” (announcement).
setup.py
Fix [ 2971827 ] and [ 3442827 ] extras/roman.py moved to docutils/utils/roman.py
docutils/frontend.py
Fix [ 3481980 ] Use os.getcwdu() in make_paths_absolute().
docutils/io.py
Fix [ 3395948 ] (Work around encoding problems in Py3k).
mode argument for FileOutput avoids code replication in BinaryFileOutput.
New exceptions InputError and OutputError for IO errors in FileInput/FileOutput.
docutils/core.py:
No “hard” system exit on file IO errors: catch and report them in Publisher.reportException instead. Allows handling by a calling application if the configuration setting traceback is True.
docutils/utils.py -> docutils/utils/__init__.py
docutils.utils is now a package (providing a place for sub-modules)
注解
docutils/math, docutils/error_reporting.py, and docutils/urischemes.py will move to the utils package in the next release, too. See RELEASE-NOTES
DependencyList uses io.FileOutput and ‘utf8’ encoding to prevent errors recording non-ASCII filenames (fixes [ 3434355 ]).
Fix relative_path() with source=None and unicode target.
docutils/parsers/rst/states.py
Fix [ 3402314 ] allow non-ASCII whitespace, punctuation characters and “international” quotes around inline markup.
Use field_marker pattern to look for start of a directive option block (fixes [ 3484857 ]).
docutils/parsers/rst/tableparser.py
Fix [ 2926161 ] for simple tables. (Combining chars in grid tables still contribute to cell width.)
docutils/writers/latex2e/__init__.py
Support the abbreviation and acronym standard roles.
Record only files required to generate the LaTeX source as dependencies.
Fix handling of missing stylesheets.
Use
\setcounter{secnumdepth}{0}
instead of*
-versions when suppressing LaTeX section numbering.Use
\DUtitle
for unsupported section levelsApply [ 3512791 ] do not compare string literals with “is”
docutils/writers/xetex/__init__.py
Avoid code duplication with latex2e writer (solves [ 3512728 ]).
docutils/writers/html4css1/__init__.py
Change default for math-output setting to MathJax.
Fix handling of missing stylesheets.
docutils/writers/docutils_xml.py
Use the visitor pattern with default_visit()/default_depart() methods instead of minidom to facilitate special handling of selected nodes.
Support raw XML (inserted as-is inside a <raw></raw> node).
docutils/writers/manpage.py
Do not emit comment line with trailing blank. Problematic for VCS.
Release 0.8.1 (2011-08-30)¶
General:
Fix [ 3364658 ] (Change last file with Apache license to BSD-2-Clause) and [ 3395920 ] (correct copyright info for rst.el).
test/
Apply [ 3303733 ] and [ 3365041 ] to fix tests under Py3k.
docutils/writers/latex2e/__init__.py
Clean up Babel language setting. Restores Sphinx compatibility.
Release 0.8 (2011-07-07)¶
General:
Handle language codes according to BCP 47.
If the specified language is not supported by Docutils, warn and fall back to English.
Math support: reStructuredText “math” role and directive,
math
andmath_block
doctree elements.Decode command line arguments with the locale’s preferred encoding (to allow, e.g.,
--title=Dornr枚schen
).Orphaned “python” reader and “newlatex2e” writer moved to the sandbox.
New sub-module error_reporting: handle encoding/decoding errors when reporting exceptions.
Some additions to the Docutils core are released under the 2-Clause BSD license, see COPYING for details.
reStructuredText:
Most directives now support a “name” option that attaches a reference name.
Directive content may start on the first line also when the directive type accepts options.
docs/dev/policies.txt:
Recommend the 2-Clause BSD license (http://www.spdx.org/licenses/BSD-2-Clause) for code that is kept under the author’s copyright.
tools/buildhtml.py:
Fix
--local
switch.
Fix [ 3018371 ] Added Lithuanian mappings by Dalius Dobravolskas.
docutils/writers/html4css1/__init__.py
Set “lang” argument for objects with class argument “language-<language tag>”.
New setting “math-output” with support for HTML, MathML, and LaTeX.
docutils/writers/latex2e/__init__.py
Fix [ 3043986 ] AttributeError using :local: with table of content.
Place title data in the document preamble.
Load babel package only if required.
Update list of supported languages.
New config setting “hyperref-options”. No hard-coded “unicode” hyperref option (clash with xetex).
Set language for custom roles, paragraphs, block-quotes, and line-quotes with class argument “language-<language tag>”.
Fix [ 3095603 ] wrong quotes output for russian and other languages.
Convert image URI to a local file path.
Apply [ 3148141 ] fix multicolumn support when a colspanning cell has more than one paragraph (Wolfgang Scherer).
leavevmode before longtable only when needed (prevents spurious vspace)
do not advance table counter for tables without caption
docutils/writers/xetex/__init__.py
New writer generating LaTeX code for compiling with
xelatex
.A separate writer (inheriting from latex2e) instead of a
--xetex
option allows separate config options for XeTeX vs. LaTeX2e.
docutils/writers/manpage.py
Fix: BUG#3219183 - vertical space in definition lists containing markup.
Fix: vertical space cleaning for option group
.
.
tools/editors/emacs/rst.el:
Fix [ 3001100 ] does not handle spaces in filenames (thanks to Jakub Wilk)
docutils/utils.py:
strip whitespace from stylesheet arguments
exclude combining chars from column_width() (partial fix for [ 2926161 ])
docutils/parsers/rst/directives/misc.py:
Fix [ 1830389 ] Replace not breaking on getting system_messages from nested_parse
docutils/io.py:
Do not close() sys.stdin, sys.stdout, or sys.stderr. Prevents
Exception ValueError: 'I/O operation on closed file.'
with Python聽3.
Release 0.7 (2010-07-07)¶
General:
Fix [ 2881769 ] setup configuration.
Fix [ 2788716 ] reporting problems in included files.
docutils/io.py
FileInput opens files as text files with universal newline support (mode “rU”, configurable with the new optional argument “mode”).
docutils/nodes.py
Fix [ 2975987 ] repr(Text) failed with long string (Jeffrey C. Jacobs).
docutils/utils.py
Fix [ 2923723 ] let decode_path() tolerate path == None
docutils/writers/html4css1/__init__.py
Support SVG and SWF images (thanks to Stefan Rank).
Generate valid XHTML for centered images with targets. Use CSS classes instead of “align” tags for image alignment.
docutils/writers/latex2e/__init__.py
Use transforms.writer_aux.Admonitions to “normalize” special admonitions.
Use the
\url
command for URLs (breaks long URLs instead of writing into the margin).Preserve runs of spaces in inline literals.
Deprecate
figure_footnotes
setting.Rename
use_latex_footnotes
setting to docutils_footnotes.New
latex_preamble
setting.Use PDF standard fonts (Times/Helvetica/Courier) as default.
Fix hyperlink targets (labels) for images, figures, and tables.
Apply [ 2961988 ] Load babel after inputenc and fontenc.
Apply [ 2961991 ] Call hyperref with unicode option.
Drop the special output_encoding default (“latin-1”). The Docutils wide default (usually “UTF-8”) is used instead.
Render inline markup in document title and subtitle.
Fix numbering depth with LaTeX section numbering.
Update Unicode -> LaTeX translations.
Fix bug with topic directive (thanks to Alan G Isaac for reporting).
docutils/writers/manpage.py
Fix: supported attribute (thanks to peter2108).
Remove trailing blanks in code (keep in sync with mercurial version).
Titles level 1, that is
.SH
, always uppercase.Apply patch from mg: literal text should be bold in man-pages.
docutils/nodes.py
Fix: encoding
'ascii'
must be lowercase to prevent problems for turkish locale.
setup.py:
Python聽3 support: copy test/ and tools/ to the build-dir and convert Python sources with 2to3.
Release 0.6 (2009-10-11)¶
General:
Docutils is now compatible with Python versions from 2.3 up to 2.6 and convertible to 3.1 code.
Node.__nonzero__ returns True instead of 1.
use os.walk instead os.path.walk.
minimize “types” module where possible.
Backwards-compatible changes to remove python2.6 -3 deprecation warnings
Text nodes now subclass unicode rather than UserString (which is gone in python 3.0).
3.0 compatibility module docutils._compat
Drop 2.2 compatibility workarounds.
Drop extras/optparse.py and extras/textwrap.py (stdlib modules since 2.3).
OpenOffice export: ODT writer moved from sandbox to Doctutils core.
Unix man page export: manpage writer moved from sandbox to Doctutils core.
Apply [ 1719345 ] Galician translation
Apply [ 1905741 ] Polish translation
Apply [ 1878977 ] make_id(): deaccent characters.
Apply [ 2029251 ] return nonzero when tests fail.
Fix [ 1692788 ] allow UTF-8 in style sheets.
Fix [ 2781629 ] support non-ASCII chars in file names.
Apply [ 2845002 ] let
--no-raw
disable raw roles too.Fix [ 2831643 ] by renaming DirectiveError.message to DirectiveError.msg
Fix [ 2821266 ] –strict option works now like –halt=info.
Fix [ 2788716 ] DirectiveError now correctly reports source and line.
Fix [ 1627229 ] hyperlink references in substitutions.
The “newlatex” writer is orphaned.
reStructuredText:
Documented Unicode characters allowed as inline markup openers, closers, and delimiters.
Allow units for all length specifications.
Allow percent sign in “scale” argument of “figure” and “image” directives.
Bugfix: The “figalign” argument of a figure now works as intended (aligning the figure, not its contents).
Align images with class “align-[right|center|left]” (allows setting the alignment of an image in a figure).
docutils/nodes.py:
Added
Element.__contains__
method, for the in-operator.
docutils/parsers/rst/states.py:
Apply [ 1994493 ] Patch to support all kinds of quotes in inline markup.
Added support for Unicode inline markup delimiters “鈥� 鈥� 鈥� 鈥� 鈥�” and “聽” (non-breaking space), and “隆 驴” openers.
docutils/parsers/directives/misc.py:
Added
start-line
andend-line
options to “include” directive to select a range of lines.Hard tabs in literal inclusions are replaced by spaces. This is configurable via the new
tab-width
option of the “include” directive (a negative tab-width prevents tab expansion).
docutils/utils.py:
Add
get_stylesheet_list
function.Apply [ 2834836 ] print info at halt
docutils/transforms/universal.py:
Raise default priority of StripClasses to exclude stripped classes from the ToC.
docutils/writers/html4css1/__init__.py:
--stylesheet
and--stylesheet-path
options support a comma separated list of stylesheets.Address [ 1938891 ] Inline literal text creates “pre” span only when needed to prevent inter-word line wraps.
Use translate method instead of repeated replace calls.
Fix [ 1757105 ] New
table-style
option. Added to standard table classes to allow CSS styling that does not interfere with other table-using constructs (field lists, citations, …).
docutils/writers/newlatex2e/__init__.py:
Apply [ 1612821 ] Double quotes in literal text in Italian/German
docutils/writers/latex2e/__init__.py (see also docs/user/docutils-05-compat.sty.html) :
Add
--embed-stylesheet
option.Apply [ 1474017 ] image vertical alignment is reversed.
Apply [ 2051599 ] multi-page tables in latex writer (from pabigot).
Change: has_key for dictionaries (not Nodes) to in-operator.
Merge adjacent citations into one latex cite command.
Failsave implementation of custom roles. LaTeX compilation now ignores unknown classes instead of aborting with an error.
Support custom roles based on standard roles.
LaTeX packages can be used as
--stylesheet
arguments without restriction. (A style sheet is now referenced with the\usepackage
command, if it ends with.sty
or has no extension.)Add
bp
to lenghts without unit (prevents LaTex errors).Correctly write length unit
pt
asbp
in LaTeX.Do not convert
px
topt
(px
is supported by pdfTeX since 2005-02-04 as a configurable length unit).Do not use fontenc, nor the obsolete ‘ae’ and ‘aeguill’ packages if font-encoding is set to ‘’. LaTeX defaults to OT1 then.
Set sub- and superscript role argument in text mode not as math. Use a custom role based on sub-/superscript if you want italic shape.
Shorter preamble and less dependencies: Load packages and define macros only if required in the document.
Use the name prefix
DU
for all Docutils specific LaTeX macros.New custom environments and commands with optional “classes” argument.
Simpler LaTeX encoding, e.g. “%” instead of “{%}”.
Better conformance to Docutils specifications with
--use-latex-toc
. Support for LaTeX generated ToC also with unnumbered sections.If ‘sectnum_xform’ is False, the ‘sectnum’ directive triggers section numbering by LaTeX.
Use default font in admonitions and sidebar.
Align of image in a figure defaults to ‘center’.
Bugfix: Newlines around targets and references prevent run-together paragraphs.
Fix internal hyperlinks.
Use class defaults for page margins (‘typearea’ now optional).
Float placement made configurable, default changed to “here definitely”.
Typeset generic topic as “quote block with title”.
Use template (file and configuration option).
In the default template, load cmap.sty (fix text extraction in PDF) and fixltx2e.sty (LaTeX patches, textsubscript).
Render doctest blocks as literal blocks (fixes [ 1586058 ]).
Use translate instead of repeated replace calls for text encoding.
Hyperlinked footnotes and support for symbol footnotes and
--footnote-references=brackets
with--use-latex-footnotes
.Complete pairs of binary options (
--figure-footnotes, --figure-citations, --link-stylesheet
,--use-docutils-toc, --use-docutils-docinfo, --topic-abstract
)New defaults: - font-encoding: “T1” (formerly implicitely set by ‘ae’). - use-latex-toc: true (ToC with page numbers). - use-latex-footnotes: true (no mixup with figures).
docutils/writers/manpage.py
Do not print version at document end, this is done by the viewer.
Do not print date at document end, this is done by the viewer.
Fix storage of docinfo fields for none standard fields.
docutils/tools/rst2man.py
Release 0.5 (2008-06-25)¶
docutils/languages/he.py: Added to project: Hebrew mappings by Meir Kriheli.
docutils/parsers/rst/languages/he.py: Added to project: Hebrew mappings by Meir Kriheli.
docutils/frontend.py:
Configuration files are now assumed and required to be UTF-8-encoded.
Paths of applied configuration files are now recorded in the runtime setting
_config_files
(accessible via--dump-settings
).Added
--strip-elements-with-class
and--strip-class
options (strip_elements_with_classes
andstrip_classes
settings).
docutils/io.py:
Added code to determine the input encoding from data: encoding declarations or the presence of byte order marks (UTF-8 & UTF-16).
Added support for IronPython 1.0.
docutils/nodes.py:
Added
document.__getstate__
method, for pickling.
docutils/parsers/rst/states.py:
Allow
+
and:
in reference names.Unquoted targets beginning with an underscore (
.. __target: URI
) are no longer accepted.Added support for multiple attributions in a physical block quote (indented text block), dividing it into multiple logical block quotes.
Added support for unicode bullets in bullet lists: “鈥�”, “鈥�”, and “鈦�”.
Added support for new object-oriented directive interface, retaining compatibility to the old functional interface.
Added support for throwing
DirectiveError
’s from within directive code.
docutils/parsers/rst/__init__.py:
Added
Directive
base class.Added
DirectiveError
base class.Fixed
file_insertion_enabled
&raw_enabled
setting definitions.
docutils/parsers/directives/:
Refactored all reStructuredText directives to use the new object-oriented directive interface. Errors are now (mostly) thrown using the new
DirectiveError
class.
docutils/parsers/directives/misc.py:
Added
start-after
andend-before
options toinclude
directive; thanks to Stefan Rank.
docutils/transforms/universal.py:
Added
StripClassesAndElements
transform to remove from the document tree all elements with classes insettings.strip_elements_with_classes
and all “classes” attribute values inself.document.settings.strip_classes
.
docutils/transforms/writer_aux.py:
Added
Admonitions
transform to transform specific admonitions (likenote
,warning
, etc.) into generic admonitions with a localized title.
docutils/writers/html4css1/__init__.py:
Moved template functionality from the PEP/HTML writer here.
Expanded the fragments available in the
parts
attribute.Moved
id
attributes from titles to surroundingdiv
elements.Dropped all
name
attributes ofa
elements (id
is universally supported now).template.txt
is now opened in text mode instead of binary mode (to ensure Windows compatibility).a
elements now have an “internal” or “external” class, depending on reference type.
docutils/writers/html4css1/template.txt: Added to project.
docutils/writers/pep_html/:
Moved template functionality to the HTML writer.
docutils/writers/s5_html/__init__.py:
Added
view_mode
&hidden_controls
settings (--view-mode
&--hidden-controls/--visible-controls
options).
docutils/writers/latex2e/__init__.py:
Add
--literal-block-env
Fix: escaping
%
in href urls.Move usepackage hyperref after stylesheet inclusion.
Fix: scrartcl does not have chapter but scrreprt.
Add newline after
\end{verbatim}
.Merge smaller differences from latex2e_adaptive_preamble.
Add
use-part-section
.Put leavevmode before longtable to avoid having it moved before sub/pargraph.
Using leavemode option_list no longer needs to check if parent is a definition list.
Append
\leavemode
to definition list terms.No longer write visit_/depart_definition_list_item comments to output.
Table column width with 3 decimal places.
Add table stubs support (boldfont).
Add assemble_parts to writer.
Add simply support for nested tables.
Fix verbatim in tables if use-verbatim-when-possible.
Use section commands down to subparagraph.
Put ensuremath around some latin1 chars.
Set
usepackage[utf8x]{inputenc}
for utf-8.New option
--use-bibtex=style,db1,db2
.New option
--reference-label
to allow usage of LaTeX ref for labels in section references.Add a label after every section to support sectionnumbers as reference labels.
Fix: bug# 1605376 rst2latex: bad options group list
Remove inactive code for use_optionlist_for_option_list.
Remove latex comments from option_list output.
Fix: bug# 1612270 double qoutes in italian literal.
Fix: output
hypertarget{ node.get(refid) }{}
from visit_target.Add option –use-latex-abstract.
Image width unit
px
is translated topt
.Add image height support.
Fix: image width
70%
is converted0.700\linewidth
. bug #1457388Fix: Do not escape underscores in citation reference labels if use-latex-citations is set.
Use centering instead of center for figure contents, to avoid vertical space.
Recognize table class: borderless, nolines, booktabs, standard.
Fix: Renaming contents section does not work with latex writer; SF bug #1487405.
Applied patch for custom roles with classes from Edward Loper.
Fixed bug that caused crashes with more than 256 lists.
docutils/writers/pep_html/__init__.py:
Changed to support new python.org website structure and pep2pyramid.py.
docs/howto/security.txt: “Deploying Docutils Securely”, added to project.
tools/buildhtml.py:
- – Added
ignore
setting to exclude a list of shell patterns (default:
.svn:CVS
).
- – Added
tools/editors/emacs/rst.el:
Changed license to “GPL”.
Added
rst-straighten-decorations
function.The
compile
module is now always loaded.Added
rst-toggle-line-block
function.Headings consisting only of non-ASCII characters are now recognized by
rst-toc
andrst-adjust
.Added font-lock support for multi-line comments where the first comment line is empty.
Added
(require 'font-lock)
.
setup.py:
Provide descriptive error message if distutils is missing.
Release 0.4 (2006-01-09)¶
General:
Updated the project policies for trunk/branch development & version numbering.
docutils/__init__.py:
Added
__version_details__
attribute to describe code source (repository/snapshot/release).Replaced
default_transforms
attribute of TransformSpec withget_transforms()
method.
docutils/core.py:
Added
publish_doctree
andpublish_from_doctree
convenience functions, for document tree extraction and reprocessing.
docutils/io.py:
Added
DocTreeInput
class, for reprocessing existing documents.Added support for non-Unicode (e.g. binary) writer output.
docutils/nodes.py:
Re-introduced
Targetable.indirect_reference_name
, for MoinMoin/reST compatibility (removed in r3124/r3129).Added
serial_escape
function; escapes string values that are elements of a list, for serialization. Modified Docutils-XML writing (Element._dom_node
) and pseudo-XML writing (Element.starttag
) to useserial_escape
.Added
Node.deepcopy()
method.Removed the internal lists
document.substitution_refs
,document.anonymous_refs
, anddocument.anonymous_targets
.Added a “container” element.
Fixed bug where values of list-valued attributes of elements originating from custom interpreted text roles (i.e., with custom classes) were being shared between element instances. Reported by Shmuel Zeigerman.
docutils/statemachine.py:
Added trailing whitespace stripping to
string2lines()
.Added
StringList.pad_double_width()
&.replace()
for East Asian double-width character support.
docutils/utils.py:
Added
east_asian_column_width()
for double-width character support.
docutils/languages/ja.py: Added to project: Japanese mappings by Hisashi Morita.
docutils/languages/zh_cn.py: Added to project: Simplified Chinese mappings by Panjunyong.
docutils/parsers/null.py: Added to project; a do-nothing parser.
docutils/parsers/rst/__init__.py:
Added validator to tab_width setting, with test. Closes SF bug #1212515, report from Wu Wei.
docutils/parsers/rst/states.py:
Fixed bug with escaped colons indicating a literal block.
Fixed bug with enumerated lists (SF#1254145).
Backslash-escaped colons inside of field names are now allowed.
Targets (implicit and explicit), anonymous hyperlink references and auto-numbered footnote references inside of substitution definitions are now disallowed.
Fixed bug: list items with blank first lines.
Fixed bug: block quote attributions with indented second lines.
Added East Asian double-width character support (Python 2.4 only).
docutils/parsers/rst/tableparser.py:
Added East Asian double-width character support (Python 2.4 only).
docutils/parsers/rst/directives/body.py:
Added the “container” directive.
docutils/parsers/rst/directives/misc.py:
Added the “default-role”, “title”, and “date” directives.
Added standard data file syntax to the “include” directive.
Added support for “class” directive content.
docutils/parsers/rst/directives/images.py:
Added
indirect_reference_name
support for images with a target option.Added support for image width and height units.
Fixed bug with image “target” options.
docutils/parsers/rst/directives/references.py:
Added “class” attribute to “target-notes” directive, for footnote_reference classes.
docutils/parsers/rst/include/: Directory added to project; contains standard data files for the “include” directive. Initial contents: character entity substitution definition sets, and a set of definitions for S5/HTML presentations.
docutils/parsers/rst/languages/ja.py: Added to project: Japanese mappings by David Goodger.
docutils/parsers/rst/languages/zh_cn.py: Added to project: Simplified Chinese mappings by Panjunyong.
docutils/readers/__init__.py:
Added universal.Decorations and universal.ExposeInternals transforms as default transforms for all readers.
Added
ReReader
base class for readers that reread an existing document tree.
docutils/readers/doctree.py: Added to project; a reader for existing document trees.
docutils/transforms/frontmatter.py:
Fixed the DocInfo transform to handle SVN-style expansion of the “Date” keyword.
In
DocInfo.extract_authors
, treat the contents of “authors” fields uniformly.
docutils/transforms/misc.py:
Added misc.Transitions transform, extracted from universal.FinalChecks.
docutils/transforms/references.py:
Added references.DanglingReferences transform, extracted from universal.FinalChecks.
Fixed bug with doubly-indirect substitutions.
Added footnote_reference classes attribute to “TargetNotes”.
Fixed bug with circular substitution definitions that put Docutils into an infinite loop.
docutils/transforms/universal.py:
Added universal.ExposeInternals transform, extracted from universal.FinalChecks.
Removed universal.FinalChecks transform (logic has been moved to several new transforms).
Fixed bug with the “expose_internals” setting and Text nodes (exposed by the “rawsource” internal attribute).
Added the universal.StripComments transform, implementation of the “strip_comments” setting.
docutils/transforms/writer_aux.py: Added to project; auxiliary transforms for writers.
Added
Compound
transform, which flattens compound paragraphs.
docutils/writers/: Several writer modules (html4css1.py) were converted into packages. Support modules and data files have been moved into the packages. The stylesheets for the HTML writers are now installed along with the code, the code knows where to find them, and the default is to use them (actually, to embed them). Some adjustments to configuration files may be necessary. The easiest way to obtain the new default behavior is to remove all settings whose name includes “stylesheet”.
docutils/writers/__init__.py:
Added universal.Messages and universal.FilterMessages transforms as default transforms for all writers.
Added
UnfilteredWriter
base class for writers that pass the document tree on unchanged.
docutils/writers/docutils_xml.py:
Made
xmlcharrefreplace
the default output encoding error handler.
docutils/writers/html4css1/:
Added support for image width and height units.
Made
xmlcharrefreplace
the default output encoding error handler.Made
--embed-stylesheet
the default rather than--link-stylesheet
.Moved “id” attribute from container (section etc.) to title’s <a> tag, to be on the same tag as “name”. (!!! To be reverted in Docutils 0.5.)
Added vertical space between fields of field lists.
Added
--compact-field-lists
option to remove vertical space in simple field lists.Made cloaking of email addresses with
--cloak-email-addresses
less obtrusive.Fixed support for centered images.
Added support for class=”compact” & class=”open” lists.
docutils/writers/latex2e/:
Underscores in citekeys are no longer escaped.
docutils/writers/newlatex2e/unicode_map.py: Added to project; mapping of Unicode characters to LaTeX equivalents.
docutils/writers/s5_html/: Package added to project; writer for S5/HTML slide shows.
docs/dev/distributing.txt: Added to project; guide for distributors (package maintainers).
docs/dev/hacking.txt: Added to project; guide for developers.
docs/ref/doctree.txt:
Updated for plural attributes “classes”, “ids”, “names”, “dupnames”.
Added the “container” element.
docs/ref/docutils.dtd:
Updated for plural attributes “classes”, “ids”, “names”, “dupnames”.
docs/user/emacs.txt: Added to project; a document about Emacs support for reStructuredText and Docutils.
docs/user/links.txt: Added to project; lists of Docutils-related links.
docs/user/mailing-lists.txt: Added to project; information about Docutils-related mailing lists and how to access them.
docs/user/slide-shows.txt: Added to project; example of and docs for the S5/HTML writer (
rst2s5.py
front end).docs/ref/rst/definitions.txt: “reStructuredText Standard Definition Files”, added to project.
test/coverage.sh: Added to project; test coverage script.
test/DocutilsTestSupport.py:
Added support for specifying runtime settings at the suite level.
test/test_functional.py:
Added the
clear_output_directory
function.Added support for
_test_more
functions in functional test config files.
tools/rst2s5.py: Added to project; front end for the S5/HTML writer.
tools/rstpep2html.py: Renamed from pep.py.
tools/dev/create_unimap.py: Added to project; script to create the docutils/writers/unimap_latex.py mapping file.
tools/dev/profile_docutils.py: Added to project; profiler script.
tools/dev/unicode2rstsubs.py: Moved from tools/unicode2rstsubs.py.
tools/editors/emacs/restructuredtext.el, tools/editors/emacs/rst-html.el, tools/editors/emacs/rst-mode.el: Removed from project; the functionality is now contained in rst.el.
tools/editors/emacs/rst.el: Added to project. Added many features and fixed many bugs. See docs/user/emacs.txt for details.
tools/stylesheets: Removed from project. Stylesheets have been renamed and moved into writer packages.
Release 0.3.9 (2005-05-26)¶
General:
Eliminated and replaced all uses of the old string attributes
id
,name
,dupname
andclass
with references to the new list attributesids
,names
,dupnames
andclasses
throughout the whole source tree.
docutils/core.py:
Enabled
--dump-*
options when--traceback
specified, allowing for easier debugging.In
Publisher.publish()
, expanded the generic top-level exception catching.
docutils/examples.py:
Added
internals
function for exploration.
docutils/io.py:
Fixed
Input.decode
method to apply heuristics only if no encoding is explicitly given, and to provide better reporting of decoding errors.The
Input.decode
method now removes byte order marks (BOMs) from input streams.
docutils/nodes.py:
image
element class changed to subclass of Element, not TextElement (it’s an empty element, and cannot contain text).Added
attr_defaults
dictionary for default attribute values.Added empty list as default value for the following attributes:
ids
,names
,dupnames
,classes
, andbackrefs
.Added
document.decoration
attribute,document.get_decoration
method, anddecoration.get_header
&.get_footer
methods.Added
Element.update_basic_atts()
andElement.substitute()
methods.
docutils/utils.py:
Removed
docutils.utils.Reporter.categories
,docutils.utils.ConditionSet
, and all references to them, to simplify error reporting.
docutils/languages/nl.py: Added to project; Dutch mappings by Martijn Pieters.
docutils/parsers/rst/__init__.py:
Added settings:
file_insertion_enabled
&raw_enabled
.
docutils/parsers/rst/states.py:
Added check for escaped at-mark to prevent email address recognition.
Fixed option lists to allow spaces inside
<angle-bracketed option arguments>
.Allowed whitespace in paths and URLs.
Added auto-enumerated list items.
Fixed bug that assumed
.. _
and.. |
were invariably followed by text.Added support for table stub columns.
docutils/parsers/rst/directives/__init__.py:
Allowed whitespace in paths (
path
function).Added
uri
directive option conversion function.
docutils/parsers/rst/directives/body.py:
Fixed illegal context bug with “topic” directive (allowed within sidebars; not within body elements).
docutils/parsers/rst/directives/images.py:
Allowed whitespace (stripped) in “image” & “figure” directive URLs.
Added support for the
file_insertion_enabled
setting in the “figure” directive (disables “figwidth” option).“image” directive: added checks for valid values of “align” option, depending on context. “figure” directive: added specialized “align” option and attribute on “figure” element.
Made “:figwidth: image” option of “figure” directive work again.
Fixed bug with reference names containing uppercase letters (e.g.
Name_
) in “target” option of “image” directive.
docutils/parsers/rst/directives/misc.py:
Fixed “include” and “raw” directives to catch text decoding errors.
Allowed whitespace in “include” & “raw” directive paths.
Added support for
file_insertion_enabled
&raw_enabled
settings in “include” & “raw” directives.
docutils/parsers/rst/directives/parts.py:
Added “header” & “footer” directives.
Fixed illegal context bug with “contents” directive (topics allowed within sidebars; not within body elements).
docutils/parsers/rst/directives/tables.py:
Added “list-table” directive.
Caught empty CSV table bug.
Added support for the
file_insertion_enabled
setting in the “csv-table” directive.Added
stub-columns
option to “csv-table” and “list-table” directives.
docutils/parsers/rst/languages/nl.py: Added to project; Dutch mappings by Martijn Pieters.
docutils/readers/standalone.py:
Added
--section-subtitles
and--no-section-subtitles
options to activate or deactivate the SectSubTitle transform.
docutils/transforms/frontmatter.py:
Added SectSubTitle transform to promote titles of lone subsections to subtitles.
docutils/transforms/references.py:
Fixed mislocated internal targets bug, by propagating internal targets to the next node, making use of the newly added support for multiple names and IDs.
Fixed duplicate footnote label bug.
Replaced
ChainedTargets
with more genericPropagateTargets
transform.
docutils/writers/html4css1.py:
Fixed unencoded stylesheet reference bug (characters like “&” in stylesheet references).
target
nodes now appear asspan
tags (instead ofa
tags).Added support for multiple IDs per node by creating empty
span
tags.Added the
field_name_limit
&option_limit
settings & support.Added support for table stub columns.
Added support for the
align
attribute onfigure
elements.Added the
cloak_email_addresses
setting & support.Added
html_prolog
,html_head
,html_body
,html_title
, &html_subtitle
to parts dictionary exposed bydocutils.core.publish_parts
.Added support for section subtitles.
docutils/writers/latex2e.py:
Fixed tables starting with more than one multirow cell.
Improved –use-latex-docinfo so that organization/contact/address fields are lumped with the last author field and appear on the titlepage.
Made sure the titlepage is always shown with –use-latex-docinfo, even if the document has no title.
Made sure that latex doesn’t fill in today’s date if no date field was given.
Added support for section subtitles.
docutils/writers/newlatex2e.py: Added to project; a new LaTeX writer (under development).
docutils/writers/null.py: Added to project; a do-nothing Writer.
docs/api/publisher.txt:
Added “
publish_parts
Details” section.
docutils/dev/repository.txt: Added to project; information about the Docutils Subversion repository.
docs/ref/docutils.dtd:
Added a
stub
attribute to thecolspec
element via thetbl.colspec.att
parameter entity.Allowed topic elements within sidebars
Added an
align
attribute to thefigure
element.
tools/rst2newlatex.py: Added to project; front end for the new LaTeX writer.
Release 0.3.7 (2004-12-24)¶
docutils/frontend.py:
Added options: –input-encoding-error-handler, –record-dependencies, –leave-footnote-reference-space, –strict-visitor.
Added command-line and config file support for “overrides” setting parameter.
docutils/io.py:
Added support for input encoding error handler.
docutils/nodes.py:
Added dispatch_visit and dispatch_departure methods to NodeVisitor; useful as a hook for Visitors.
Changed structure of
line_block
; addedline
.Added
compound
node class.Added a mechanism for Visitors to transitionally ignore new node classes.
docutils/utils.py:
Moved
escape2null
andunescape
functions from docutils/parsers/rst/states.py.
docutils/parsers/rst/roles.py:
Added “raw” role.
Changed role function API: the “text” parameter now takes null-escaped interpreted text content.
docutils/parsers/rst/states.py:
Fixed bug where a “role” directive in a nested parse would crash the parser; the state machine’s “language” attribute was not being copied over.
Added support for line block syntax.
Fixed directive parsing bug: argument-less directives didn’t notice that arguments were present.
Removed error checking for transitions.
Added support for multiple classifiers in definition list items.
Moved
escape2null
andunescape
functions to docutils/utils.py.Changed role function API: the “text” parameter now takes null-escaped interpreted text content.
Empty sections and documents are allowed now.
docutils/parsers/rst/directives/__init__.py:
Added
encoding
directive option conversion function.Allow multiple class names in class_option conversion function.
docutils/parsers/rst/directives/body.py:
Converted the line-block directive to use the new structure.
Extracted the old line-block functionality to the
block
function (still used).Added
compound
directive (thanks to Lea Wiemann).
docutils/parsers/rst/directives/misc.py:
Added “encoding” option to “include” and “raw” directives.
Added “trim”, “ltrim”, and “rtrim” options to “unicode” directive.
Allow multiple class names in the “class” directive.
docutils/parsers/rst/directives/parts.py:
Directive “sectnum” now accepts “prefix”, “suffix”, and “start” options. Thanks to Lele Gaifax.
docutils/parsers/rst/directives/tables.py:
Added “encoding” directive to “csv-table” directive.
Added workaround for lack of Unicode support in csv.py, for non-ASCII CSV input.
docutils/transforms/misc.py:
Fixed bug when multiple “class” directives are applied to a single element.
Enabled multiple format names for “raw” directive.
docutils/transforms/references.py:
Added support for trimming whitespace from beside substitution references.
docutils/transforms/universal.py:
FinalChecks now checks for illegal transitions and moves transitions between sections.
docutils/writers/html4css1.py:
HTMLTranslator.encode now converts U+00A0 to “ ”.
“stylesheet” and “stylesheet_path” settings are now mutually exclusive.
Added support for the new line_block/line structure.
–footnote-references now overrides –trim-footnote-reference-space, if applicable.
Added support for
compound
elements.Enabled multiple format names for “raw” directive.
<p>
tags of a paragraph which is the only visible child of the document node are no longer stripped.Moved paragraph-compacting logic (for stripping
<p>
tags) to new methodshould_be_compact_paragraph()
.Added class=”docutils” to
dl
,hr
,table
andtt
elements.“raw” elements are now surrounded by
span
ordiv
tags in the output if they have theirclass
attribute set.The whole document is now surrounded by a
<div class="document">
element.Body-level images are now wrapped by their own
<div>
elements, with image classes copied to the wrapper, and for images which have the:align:
option set, the surrounding<div>
now receives a class attribute (likeclass="align-left"
).
docutils/writers/latex2e.py:
no newline after depart_term.
Added translations for some Unicode quotes.
Added option “font-encoding”, made package AE the default.
“stylesheet” and “stylesheet_path” settings are now mutually exclusive.
–footnote-references now overrides –trim-footnote-reference-space, if applicable.
The footnote label style now matches the footnote reference style (“brackets” or “superscript”).
Added support for
compound
elements.Enabled multiple format names for “raw” directive.
docs/ref/docutils.dtd:
Changed structure of the
line_block
element; addedline
.Added
compound
element.Added “ltrim” and “rtrim” attributes to
substitution_definition
element.Enabled multiple format names for
raw
element.Enabled multiple classifiers in
definition_list_item
elements.
docs/ref/rst/directives.txt
Marked “line-block” as deprecated.
“Class” directive now allows multiple class names.
Added “Rationale for Class Attribute Value Conversion”.
Added warning about “raw” overuse/abuse.
docs/ref/rst/restructuredtext.txt:
Added syntax for line blocks.
Definition list items may have multiple classifiers.
docs/ref/rst/roles.txt:
Added “raw” role.
tools/stylesheets/default.css:
Added support for the new line_block structure.
Added “docutils” class to
dl
,hr
,table
andtt
.
Release 0.3.5 (2004-07-29)¶
General:
Documentation cleanup/reorganization.
Created new subdirectories of docs/:
docs/user/
: introductory/tutorial material for end-usersdocs/dev/
: for core-developers (development notes, plans, etc.)docs/api/
: API reference material for client-developersdocs/ref/
: reference material for all groupsdocs/howto/
: for component-developers and core-developersdocs/peps/
: Python Enhancement Proposals
Moved
docs/*
todocs/user/
.Moved
pysource.dtd
,pysource.txt
,semantics.txt
fromspec/
todocs/dev
.Moved
doctree.txt
,docutils.dtd
,soextblx.dtd
,transforms.txt
fromspec/
todocs/ref/
.Moved
alternatives.txt
, andproblems.txt
fromspec/rst/
todocs/dev/rst/
.Moved
reStructuredText.txt
,directives.txt
,interpreted.txt
, andintroduction.txt
fromspec/rst/
todocs/ref/rst/
. Renamedinterpreted.txt
toroles.txt
,reStructuredText.txt
torestructuredtext.txt
.Moved
spec/howto/
todocs/howto
.
In order to keep the CVS history of moved files, we supplied SourceForge with a script for modifying the Docutils CVS repository.
After running the cleanup script:
Added
docs/index.txt
.Added a
.htaccess
file to theweb
module, containing redirects for all old paths to new paths. They’ll preserve fragments (the “#name” part of a URL), and won’t clutter up the file system, and will correct the URL in the user’s browser.Added
BUGS.txt
,docs/dev/policies.txt
,docs/dev/website.txt
,docs/dev/release.txt
from all but the “To Do” list itself indocs/dev/todo.txt
.Moved “Future Plans” from
HISTORY.txt
to new “Priorities” section ofdocs/dev/todo.txt
.Added
THANKS.txt
from “Acknowledgements” inHISTORY.txt
.Added “How To Report Bugs” to
BUGS.txt
.Went through all the sources and docs (including under web/) and updated links. Mostly done by Lea Wiemann; thanks Lea! (Still need to update links in the sandboxes.)
Specific:
BUGS.txt: Added to project.
THANKS.txt: Added to project.
docutils/__init__.py:
0.3.4: Post-release.
docutils/core.py:
Added special error handling & advice for UnicodeEncodeError.
Refactored Publisher.publish (simplified exception handling & extracted debug dumps).
Renamed “enable_exit” parameter of convenience functions to “enable_exit_status”.
Enabled traceback (exception propagation) by default in programmatic convenience functions.
Now publish_file and publish_cmdline convenience functions return the encoded string results in addition to their regular I/O.
Extracted common code from publish_file, publish_string, and publish_parts, into new publish_programmatically. Extracted settings code to
Publisher.process_programmatic_settings
.In Publisher.publish, disabled
settings_overrides
whensettings
is supplied; redundant.
docutils/frontend.py:
Added help text for “–output-encoding-error-handler” and “–error-encoding-error-handler”.
Renamed “–exit” to “–exit-status”.
Simplified default-setting code.
docutils/parsers/rst/__init__.py:
Added “–pep-base-url” and “–rfc-base-url” options.
docutils/parsers/rst/states.py:
Made URI recognition more aggressive and intelligent.
docutils/parsers/rst/directives/__init__.py:
Added several directive option conversion functions.
docutils/parsers/rst/directives/body.py:
Moved “table” directive to tables.py.
docutils/parsers/rst/directives/tables.py: Table-related directives, added to project.
docutils/writers/latex2e.py:
Added “–table-style=(standard|booktabs|nolines)”
figures get “here” option (LaTeX per default puts them at bottom), and figure content is centered.
Rowspan support for tables.
Fix: admonition titles before first section.
Replace
--
in literal by-{}-
because fontencoding T1 has endash.Replave
_
in literal by an underlined blank, because it has the correct width.Fix: encode pdfbookmark titles,
#
broke pdflatex.A few unicode replacements, if output_encoding != utf
Add “–graphicx-option”.
Indent literal-blocks.
Fix: omit
\maketitle
when there is no document title.
docs/index.txt: “Docutils Project Documentation Overview”, added to project.
docs/api/cmdline-tool.txt: “Inside A Docutils Command-Line Front-End Tool”, added to project.
docs/api/publisher.txt: “The Docutils Publisher”, added to project.
docs/api/runtime-settings.txt: “Docutils Runtime Settings”, added to project.
docs/dev/policies.txt: Added to project (extracted from
docs/dev/todo.txt
, formerlyspec/notes.txt
).docs/dev/release.txt: Added to project (extracted from
docs/dev/todo.txt
, formerlyspec/notes.txt
).docs/dev/testing.txt: Added to project.
docs/dev/website.txt: Added to project (extracted from
docs/dev/todo.txt
, formerlyspec/notes.txt
).docs/ref/rst/directives.txt:
Added directives: “table”, “csv-table”.
docs/user/rst/cheatsheet.txt: “The reStructuredText Cheat Sheet” added to project. 1 page for syntax, and a 1 page reference for directives and roles. Source text to be used as-is; not meant to be converted to HTML.
docs/user/rst/demo.txt: Added to project; moved from tools/test.txt with a change of title.
test/functional/, contents, and test/test_functional.py: Added to project.
tools/buildhtml.py: Fixed bug with config file handling.
tools/html.py: Removed from project (duplicate of rst2html.py).
tools/pep2html.py: Removed from project (duplicate of Python’s nondist/peps/pep2html.py; Docutils’ tools/pep.py can be used for Docutils-related PEPs in docs/peps/).
tools/rst2pseudoxml.py: Renamed from publish.py.
tools/rst2xml.py: Renamed from docutils-xml.py.
tools/test.txt: Removed from project; moved to docs/user/rst/demo.txt.
setup.py: Now also installs
rst2latex.py
.
Release 0.3.3 (2004-05-09)¶
docutils/__init__.py:
0.3.1: Reorganized config file format (multiple sections); see docs/config.txt.
Added unknown_reference_resolvers attribute to TransformSpec.
0.3.2: Interpreted text reorganization.
0.3.3: Released.
docutils/core.py:
Catch system messages to stop tracebacks from parsing errors.
Catch exceptions during processing report & exit without tracebacks, except when “–traceback” used.
Reordered components for OptionParser; application comes last.
Added “config_section” parameter to several methods and functions, allowing front ends to easily specify their config file sections.
Added publish_parts convenience function to allow access to individual parts of a document.
docutils/examples.py: Added to project; practical examples of Docutils client code, to be used as-is or as models for variations.
docutils/frontend.py:
Added “–traceback” & “–no-traceback” options (“traceback” setting).
Implemented support for config file reorganization:
standard_config_files
moved fromConfigParser
toOptionParser
; addedOptionParser.get_config_file_settings()
and.get_standard_config_settings()
; support for old “[options]” section (with deprecation warning) and mapping from old to new settings.Reimplemented setting validation.
Enabled flexible boolean values: yes/no, true/false, on/off.
Added
Values
, a subclass ofoptparse.Values
, with support for list setting attributes.Added support for new
DOCUTILSCONFIG
environment variable; thanks to Beni Cherniavsky.Added “–no-section-numbering” option.
docutils/io.py:
Catch IOErrors when opening source & destination files, report & exit without tracebacks. Added
handle_io_errors
parameter toFileInput
&FileOutput
to enable caller error handling.
docutils/nodes.py:
Changed
SparseNodeVisitor
andGenericNodeVisitor
dynamic method definitions (viaexec
) to dynamic assignments (viasetattr
); thanks to Roman Suzi.Encapsulated visitor dynamic assignments in a function; thanks to Ian Bicking.
Added indirect_reference_name attribute to the Targetable class. This attribute holds the whitespace_normalized_name (contains mixed case) of a target.
docutils/statemachine.py:
Renamed
StringList.strip_indent
to.trim_left
.Added
StringList.get_2D_block
.
docutils/utils.py:
Added “level” attribute to SystemMessage exceptions.
docutils/languages/af.py: Added to project; Afrikaans mappings by Jannie Hofmeyr.
docutils/languages/cs.py: Added to project; Czech mappings by Marek Blaha.
docutils/languages/eo.py: Added to project; Esperanto mappings by Marcelo Huerta San Martin.
docutils/languages/pt_br.py: Added to project; Brazilian Portuguese mappings by Lalo Martins.
docutils/languages/ru.py: Added to project; Russian mappings by Roman Suzi.
docutils/parsers/rst/roles.py: Added to project. Contains interpreted text role functions, a registry for interpreted text roles, and an API for adding to and retrieving from the registry. Contributed by Edward Loper.
docutils/parsers/rst/states.py:
Updated
RSTState.nested_parse
for “include” in table cells.Allowed true em-dash character and “—” as block quote attribution marker.
Added support for <angle-bracketed> complex option arguments (option lists).
Fixed handling of backslashes in substitution definitions.
Fixed off-by-1 error with extra whitespace after substitution definition directive.
Added inline markup parsing to field lists’ field names.
Added support for quoted (and unindented) literal blocks. Driven in part by a bribe from Frank Siebenlist (thanks!).
Parser now handles escapes in URIs correctly.
Made embedded-URIs’ reference text omittable. Idea from Beni Cherniavsky.
Refactored explicit target processing code.
Added name attribute to references containing the reference name only through whitespace_normalize_name (no case changes).
parse_target no longer returns the refname after going through normalize_name. This is now handled in make_target.
Fixed bug relating to role-less interpreted text in non-English contexts.
Reorganized interpreted text processing; moved code into the new roles.py module. Contributed by Edward Loper.
Refactored
Body.parse_directive
intorun_directive
andparse_directive_block
.
docutils/parsers/rst/tableparser.py:
Reworked for
StringList
, to support “include” directives in table cells.
docutils/parsers/rst/directives/__init__.py:
Renamed
unchanged()
directive option conversion function tounchanged_required
, and added a newunchanged
.Catch unicode value too high error; fixes bug 781766.
Beefed up directive error reporting.
docutils/parsers/rst/directives/body.py:
Added basic “table” directive.
docutils/parsers/rst/directives/images.py:
Added “target” option to “image” directive.
Added name attribute to references containing the reference name only through whitespace_normalize_name (no case changes).
docutils/parsers/rst/directives/misc.py:
Isolated the import of the
urllib2
module; was causing problems on SourceForge (libssl.so.2
unavailable?).Added the “role” directive for declaring custom interpreted text roles.
docutils/parsers/rst/directives/parts.py:
The “contents” directive does more work up-front, creating the “topic” and “title”, and leaving the “pending” node for the transform. Allows earlier reference resolution; fixes subtle bug.
docutils/parsers/rst/languages/af.py: Added to project; Afrikaans mappings by Jannie Hofmeyr.
docutils/parsers/rst/languages/cs.py: Added to project; Czech mappings by Marek Blaha.
docutils/parsers/rst/languages/eo.py: Added to project; Esperanto mappings by Marcelo Huerta San Martin.
docutils/parsers/rst/languages/pt_br.py: Added to project; Brazilian Portuguese mappings by Lalo Martins.
docutils/parsers/rst/languages/ru.py: Added to project; Russian mappings by Roman Suzi.
docutils/transforms/parts.py:
The “contents” directive does more work up-front, creating the “topic” and “title”, and leaving the “pending” node for the transform. Allows earlier reference resolution; fixes subtle bug.
Added support for disabling of section numbering.
docutils/transforms/references.py:
Verifying that external targets are truly targets and not indirect references. This is because we are now adding a “name” attribute to references in addition to targets. Note sure if this is correct!
Added code to hook into the unknown_reference_resolvers list for a transformer in resolve_indirect_target. This allows the unknown_reference_resolvers to keep around indirect targets which docutils doesn’t know about.
Added specific error message for duplicate targets.
docutils/transforms/universal.py:
Added FilterMessages transform (removes system messages below the verbosity threshold).
Added hook (via docutils.TransformSpec.unknown_reference_resolvers) to FinalCheckVisitor for application-specific handling of unresolvable references.
Added specific error message for duplicate targets.
docutils/writers/__init__.py:
Added assemble_parts method to the Writer class to allow for access to a documents individual parts.
Documented & set default for
Writer.output
attribute.
docutils/writers/html4css1.py:
Fixed unicode handling of attribute values (bug 760673).
Prevent duplication of “class” attribute values (bug report from Kirill Lapshin).
Improved table grid/border handling (prompted by report from Bob Marshall).
Added support for table titles.
Added “<title />” for untitled docs, for XHTML conformance; thanks to Darek Suchojad.
Added functionality to keep track of individual parts of a document and store them in a dictionary as the “parts” attribute of the writer. Contributed by Reggie Dugard at the Docutils sprint at PyCon DC 2004.
Added proper support for the “scale” attribute of the “image” element. Contributed by Brent Cook.
Added
--initial-header-level
option.Fixed bug: the body_pre_docinfo segment depended on there being a docinfo; if no docinfo, the document title was incorporated into the body segment. Adversely affected the publish_parts interface.
docutils/writers/latex2e.py:
Changed default stylesheet to “no stylesheet” to avoid latex complaining about a missing file.
Added options and support:
--compound-enumerators
,--section-prefix-for-enumerators
, and--section-enumerator-separator
. By John F Meinel Jr (SF patch 934322).Added option
--use-verbatim-when-possible
, to avoid problematic characters (eg, ‘~’ in italian) in literal blocks.It’s now possible to use four section levels in the book and report LaTeX classes. The default article class still has three levels limit.
docs/config.txt: “Docutils Configuration Files”, added to project. Moved config file entry descriptions from tools.txt.
docs/tools.txt:
Moved config file entry descriptions to config.txt.
spec/notes.txt: Continual updates. Added “Setting Up For Docutils Development”.
spec/howto/rst-roles.txt: “Creating reStructuredText Interpreted Text Roles”, added to project.
spec/rst/reStructuredText.txt:
Added description of support for <angle-bracketed> complex option arguments to