Up to [cvs.NetBSD.org] / pkgsrc / textproc / py-docutils
Request diff between arbitrary revisions
Keyword substitution: kv
Default branch: MAIN
py-docutils: update to 0.22.2.
Release 0.22.2 (2025-09-20)
===========================
CI of snakemake on an MacOS arm failed, because homebrew possibly restored
a vim .swp-file ... maybe.
So release without the .swp.
Release 0.22.1 (2025-09-17)
===========================
Only documentation fixes.
Release 0.22.1rc1 (2025-09-13)
==============================
* docutils/frontend.py, docutils/writers/
- More consistent and concise command line help.
* docutils/nodes.py
- `nodes.Element.section_hierarchy()` now returns only elements
with non-empty "parent" attribute.
* docutils/parsers/rst/states.py
- Relax "section title" system messages from SEVERE to ERROR.
- Fix behaviour with nested parsing into a detached node
(cf. bugs #508 and #509).
- New attribute `NestedStateMachine.parent_state_machine`.
Use case: update the "current node" of parent state machine(s)
after nested parsing.
- Better error messages for grid table markup errors (bug #504),
based on patch #214 by Jynn Nelson.
* docutils/transforms/references.py
- Better error reports for hyperlinks with embedded URI or alias.
* docutils/writers/latex2e/__init__.py
- Add cross-reference anchors (``\phantomsection\label{...}``)
for elements with IDs (fixes bug #503).
- Fix cross-reference anchor placement in figures, images,
literal-blocks, tables, and (sub)titles.
- Simplify code for images nested in reference or figure elements.
py-docutils: revert 0.22 upgrade breaks qemu build https://github.com/orgs/sphinx-doc/discussions/13806 https://sourceforge.net/p/docutils/bugs/508/
py-docutils: update to 0.22.
Release 0.22 (2026-07-29)
=========================
No changes to rc5.
Release 0.22rc5 (2025-06-24)
============================
* docutils/nodes.py
- Don't invalidate indirect targets with duplicate name, if they refer to
the same refname (similar to external targets refering to the same URI).
* docutils/parsers/rst/states.py
- "Downgrade" targets generated from hyperlink references with embedded
URI or alias from explicit to implicit (cf. bug #502).
Release 0.22rc4 (2025-06-17)
============================
* docutils/nodes.py
- Don't include a "backlink" reference in system messages, if the
referenced element is an external target (not visible in the output).
* docutils/parsers/rst/directives/references.py
- Remove "name" from `TargetNotes.option_spec`.
The "target-notes" directive generates one footnote element per
external target but "name" must be unique across the document.
So far, the name was silently dropped.
* docutils/parsers/rst/languages/en.py
- Add alias "rst-class" for the "class" directive to improve the
compatibility with Sphinx.
Release 0.22rc3 (2025-06-10)
============================
* docutils/parsers/rst/states.py
- Warn about duplicate name in references with embedded internal targets.
Fixes bug #502.
* docutils/transforms/references.py
- New transform `CitationReferences`. Marks citation_references
as resolved if BibTeX is used by the backend (LaTeX).
* docutils/writers/latex2e/__init__.py
- Replace `Writer.bibtex_reference_resolver()` with a transform.
- `LaTeXTranslator.visit_inline()` now inserts labels for the
node's IDs.
- Disable footnote handling by the "hyperref" LaTeX package (Docutils'
``\DUfootnotemark`` and ``\DUfootnotetext`` macros implement
hyperlinks and backlinks). Avoids "empty anchor" warnings.
- Fix target position and re-style system messages.
- Don't merge paragraphs if there is a target between them.
* docutils/writers/manpage.py
- Do not drop text of internal targets.
Release 0.22rc2 (2025-05-22)
============================
* docutils/parsers/rst/directives/misc.py
- Pass default settings to custom parser for included file.
* docutils/parsers/rst/states.py
- Remove the `states.RSTStateMachine.memo.section_parents` cache
(introduced in Docutils 0.22rc1) that broke 3rd-party applications
employing a "mock memo".
- Use `types.SimpleNamespace` instead of a local definition for
the auxilliary class `states.Struct`.
* docutils/writers/_html_base.py
- Fix error when determining the document metadata title from the
source path and the internal `source` attribute is None.
Release 0.22rc1 (2025-05-06)
============================
* General
- We have started to add type hints to Docutils (feature-request #87).
This will be a complex programme of work and as such,
for the time being, these type hints are "provisional"
and should not be relied upon.
By default, the Python interpreter treats type hints as annotations.
Python >= 3.10 is required with active type hints
(``typing.TYPE_CHECKING == True``).
* docs/ref/docutils.dtd
- Allow multiple <term> elements in a <definition_list_item>.
Fixes feature-request #60
- The first element in a <figure> may also be a <reference>
(with nested "clickable" <image>).
* docutils/core.py
- Removed `Publisher.setup_option_parser()` (internal, obsolete).
- Allow a string value (component name or alias) in the "reader",
"parser", and "writer" arguments of `Publisher.__init__()` and
the `publish_*()` convenience functions.
* docutils/frontend.py
- Drop short options ``-i`` and ``-o`` for ``--input-encoding``
and ``--output-encoding``.
- Change the default input encoding from ``None`` (auto-detect) to "utf-8".
- Change the default value of the root_prefix_ setting to the empty string
(no change to the behaviour).
* docutils/io.py
- Change the default input encoding from ``None`` (auto-detect) to "utf-8".
* docutils/nodes.py
- Raise TypeError if the "rawsource" argument in `Element.__init__()`
is an `Element` instance.
Catches errors like ``nodes.hint(nodes.paragraph())``.
- New element category classes `SubStructural` and `PureTextElement`.
- Fix element categories.
- New method `Element.validate()`: raise `nodes.ValidationError` if
the element does not comply with the "Docutils Document Model".
Provisional.
- New "attribute validating functions"
convert string representations to correct data type,
normalize values, and
raise ValueError for invalid attribute names or values.
- New function `parse_measure()`.
- Removed `Element.set_class()`.
- Downgrade "duplicate ID" message level from SERIOUS to ERROR.
- Fix recursion in `Element.get_language_code()`.
- Do not insert <system_message> elements for duplicate explicit targets
if this results in an invalid doctree (cf. bug #489).
* docutils/parsers/docutils_xml.py
- New parser for Docutils XML sources. Provisional.
* docutils/parsers/recommonmark_wrapper.py
- New method `Parser.finish_parse()` to clean up (before validating).
* docutils/parsers/rst/languages/
- Remove mistranslations of the "admonition" directive name.
* docutils/parsers/rst/directives/__init__.py
- Support CSS3 `length units`_. Fixes feature-request #57.
* docutils/parsers/rst/directives/images.py
- New option "figname" for the "figure" directive.
Fixes feature-request #44.
* docutils/parsers/rst/directives/misc.py
- Pass the included file's path to the parser when the
"include" directive is used with :parser: option.
Enables system messages with correct source/line info.
* docutils/parsers/rst/directives/tables.py
- Removed `CSVTable.decode_from_csv()` and `CSVTable.encode_from_csv()`.
Not required with Python 3.
* docutils/parsers/rst/roles.py
- Renamed `normalized_role_options()` to `normalize_options()`
(it is now also used for directive options).
* docutils/parsers/rst/states.py
- Raise warning for empty footnotes and citations.
- Add source and line info to <enumerated-list> elements.
Fix line number of "start value not ordinal-1" INFO message.
- Change section handling to not rely on exceptions and reparsing.
Based on patch #213 by Arne Skjærholt.
Fixes bug #346 (duplicate System Messages).
* docutils/readers/__init__.py:
- Deprecate "parser_name" argument of `Reader.__init__()`.
* docutils/transforms/frontmatter.py
- Update `DocInfo` to work with corrected element categories.
* docutils/transforms/misc.py:
- Fix for `misc.Transitions`: report an error if a <transition> element
follows a <meta> or <decoration> element as this is invalid
according to ``docutils.dtd``.
* docutils/transforms/writer_aux.py
- Removed `Compound` transform.
* docutils/transforms/references.py
- Make `AnonymousHyperlinks` transform idempotent.
* docutils/transforms/universal.py
- `Messages` transform now also handles "loose" system messages
generated by the parser.
* docutils/utils/__init__.py
- Removed `Reporter.set_conditions()`.
Set attributes via configuration settings or directly.
* docutils/utils/_roman_numerals.py
- New implementation or Roman numeral support.
Replaces the local copy of the roman.py package.
* docutils/utils/error_reporting.py
- Removed. Obsolete in Python 3.
* docutils/writers/docutils-xml.py
- Do not increase indentation of follow-up lines inside inline elements.
when formatting with `indents`_.
* docutils/writers/__init__.py
- New base class `writers.DoctreeTranslator`
with auxiliary method `uri2path()`.
* docutils/writers/_html_base.py
- Make MathML the default math_output_.
- Revise image size handling methods,
use "width" and "height" attributes for unitless values.
- Add "px" to unitless table "width" values.
* docutils/writers/html4css1/__init__.py
- Keep default math_output_ value "HTML math.css".
- Add "px" to unitless table "width" values.
* docutils/writers/latex2e/__init__.py
- `LaTeXTranslator.to_latex_length()`:
Handle CSS3 `length units`_.
Remove optional argument `pxunit` (ignored since at least 2012).
Drop trailing zeroes from length values.
Move XeTeX-specific code to the "xetex" writer.
- Don't wrap references with custom reference-label_ in
a ``\hyperref`` command.
- Mark the main language when loading "babel".
- Provide an "unknown_references_resolver" (cf. `docutils/TransformSpec`)
for citation references resolved with BibTeX (cf. `use_bibtex`_ setting).
- Support SVG image inclusion with the "svg" LaTeX package (see the
`stylesheet`__ configuration setting). Solves feature-request #83
- Add "template" to the parts returned by `Writer.assemble_parts()`.
- Use standard `dict` for `LaTeXTranslator.requirements`
and `LaTeXTranslator.fallbacks`.
- Use <document> "title" attribute in pdfinfo.
- Encode <meta> element content in pdfinfo.
- Improve formatting of docinfo fields.
- `LaTeXTranslator.pop_output_collector()` now returns the popped list.
.. _reference-label: docs/user/config.html#reference-label
__ docs/user/config.html#stylesheet-latex-writers
* docutils/writers/latex2e/docutils.sty
- Replace use of ``\ifthenelse{\isundefined...`` (from "ifthen.sty")
with the eTeX primitive ``\ifdefined``.
- Add macros to emulate CSS3 `length units`_ unknown to LaTeX.
* docutils/writers/manpage.py
- Remove code for unused emdash bullets.
- Print Docutils version in header comment (feature-request #105).
- Stop converting text to full capitals (bug #481).
- Fix reference output (bug #497).
- Use macros .UR/.UE for hyperlink references unless the new
configuration setting text_references_ is True.
The current default is True (text references), it will change
to False (macro references) in Docutils 1.0.
* docutils/writers/null.py
- `null.Writer.translate()` sets `self.output` to the empty string.
* docutils/writers/odf_odt/__init__.py
- Use "px" as fallback unit for unitless image size attributes.
- Fix conversion factor of "pc" (pica) to "cm".
- Fix conversion of image width in "%" if the height is specified.
- Adjust fallback DPI value (currently not used) to match CSS units.
- Fix errors with ``*.xml`` style files (bug #494).
- Use <document> "title" attribute in document metadata.
* pyproject.toml
- Add tox.ini to the "include" list (fixes bug #486).
* tools/rst2odt.py
- Use `core.publish_file()` instead of `core.publish_file_to_binary()`.
* tools/rst2odt_prepstyles.py
- Removed. Use ``python -m docutils.writers.odf_odt.prepstyles``.
.. _length units: docs/ref/rst/restructuredtext.html#length-units
py-docutils: adapt for flit_core 3.11. Bump PKGREVISION.
py-docutils: update to 0.21.1.
Release 0.21.1 (2024-04-10)
===========================
The sdist in 0.21 was incomplete
- pypi allows no file replacing
- adding a postrelease suffix "post1": docutils-0.21.post1.tar.gz
works on pypi, but fails with pip because the metadata differs.
But if the metadata is 0.21.post1 pypi makes it a new release.
0.21.1 is the same code except for the version number.
Release 0.21 (2024-04-09)
=========================
* General
- Drop support for Python 3.7 and 3.8.
- Updated build system to use Flit_ (patch #186 by Adam Turner).
Removed ``setup.py``.
- Provide ``rst2*`` "console_scripts" `entry points`_
(without the ``.py`` extension) instead of installing the
``rst2*.py`` front end tools in the binary PATH.
.. _Flit: https://github.com/pypa/flit/
* docs/ref/docutils.dtd
- The <image> element accepts a new attribute "loading".
- Fix definitions (no change to actual behaviour):
* The <math_block> element uses the attribute "xml:space".
* The <raw> element may contain text only (no inline elements).
* The <topic> element uses the "depth" and "local" attributes to
store "contents" directive options when used as placeholder for a
generated table of contents (LaTeX writers with `use_latex_toc`_
setting).
- Documentation fix:
Reference names (``%refname.type`` and ``%refnames.type``)
are whitespace-normalized but **not** always downcased.
* docutils/frontend.py
- Allow `validate_*()` functions to be called with just the "value"
argument but keep the legacy interface for use with optparse.
- New function `frontend.validate_math_output()`.
* docutils/io.py
- Simpler and more secure `input encoding`_ default behaviour:
Do not use the locale encoding as fallback if Python is started in
`UTF-8 mode`_. Stop using "latin1" as second fallback.
Remove BOM (U+FEFF ZWNBSP at start of data) only if the "input_encoding"
configuration setting is None, '', 'utf-8-sig', 'utf-16', or 'utf-32'.
Do not remove other ZWNBSPs.
.. _UTF-8 mode: https://docs.python.org/3/library/os.html#utf8-mode
.. _input encoding: docs/api/publisher.html#encodings
- Auto-close `FileInput.source` in case of reading/decoding errors.
* docutils/languages/, docutils/parsers/rst/languages/
- Mark/Fix mistranslated localizations of the "admonition" directive
name. In Docutils, "admonition" is used as a generic term for
"advice"/"advisory"/"remark", not a reprimand.
- Add support for Georgian language (patch #204 by Temuri Doghonadze).
- Update/complete Catalan translations (patch #203 by Antoni Bella Pérez).
* docutils/nodes.py
- Remove compatibility hacks `nodes.reprunicode` and `nodes.ensure_str()`.
* docutils/parsers/rst/directives/images.py
- New "image" directive option "loading".
* docutils/parsers/rst/directives/tables.py
- Use the same CSV format for the ``:header:`` option and the main data
of the "csv-table" directive.
- Move `parsers.rst.directives.Table.process_header_option()` method
to `parsers.rst.directives.CSVTable`.
* docutils/parsers/rst/states.py
- Don't split inside "< >" when parsing "option groups" (fixes bug #474).
* docutils/parsers/rst/directives/misc.py,
docutils/parsers/rst/directives/tables.py
- Consider the new root_prefix_ setting when including files with
"include", "raw", or "csv-table" directives.
* docutils/utils/math/*
- Use custom exception `utils.math.MathError` instead of
abusing `SyntaxError` for LaTeX math syntax errors.
- Unify interface of LaTeX -> MathML conversion functions.
Improve error reporting.
- Sort ℏ (`\hslash`) as "mathord", not "mathalpha".
* docutils/utils/math/latex2mathml.py
- Generate "MathML Core" to fix rendering with Chromium/Android.
Use CSS rules instead of the deprecated "columnalign" attribute
to style <mtable> as "align" environment.
Use Mathematical Alphanumeric Symbols instead of <mstyle> with
"mathvariant" attribute.
- Use <mi> instead of <mo> for character class "mathord".
- Support "aligned" environment.
- Eliminate side-effect on later import of "tex2unichar".
* docutils/utils/math/mathml_elements.py
- New module defining MathML element classes
(outsourced from latex2mathml.py).
- Base MathML element classes on `xml.etree.ElementTree`.
* docutils/utils/roman.py
- Update to version `1.4 <https://pypi.org/project/roman/4.1/>`__.
Fixes feature-request #95 (license is now ZPL 2.1).
* docutils/utils/smartquotes.py
- Pre-compile regexps once, not with every call of `educateQuotes()`
(patch #206 by Chris Sewell).
- Simplify regexps; skip replacement rules if there is nothing to replace.
* docutils/writers/html4css1/__init__.py
- Support video inclusion via ``<object>`` tags.
* docutils/writers/html5_polyglot/\*.css
- Move MathML styles to "minimal.css" (required for correct rendering).
- Highlight heading of target section also with explicit hyperlink target.
- No additional margins for line-blocks.
* docutils/writers/_html_base.py
- Stop setting the "footnote-reference" class value for footnote references.
Since 0.18, you can use the CSS selector ``[role="doc-noteref"]``.
- Support reading/embedding images also with "file:" URI.
- Warn, if image scaling fails because the image file cannot be read.
- Support video inclusion via ``<video>`` tags
(moved here from writers/html5_polyglot/__init__.py).
- New auxiliary method `HTMLTranslator.uri2imagepath()` ensures the
image file can also be read when CWD and output directory differ.
- Consider the root_prefix_ setting when converting an image URI
to a local filesystem path.
- New `\<image>`_ attribute "loading" overrides image_loading_ setting.
- Embed SVG images as ``<svg>`` instead of data-URI.
Fixes feature-request #100.
- Generate system messages for errors/warnings during the writing stage
(image transformations, math content conversion, ...).
- Close ``<dt>`` element in `depart_term()` to allow a
"definition_list_item" with multiple "terms" (cf. feature-request #60).
- Link to the document "#top" from the ToC heading
(unless toc_backlinks_ is False).
- Transfer `id` attribute from <field> elements to the respective
<field_name> child element to allow cross-references to field-list items
(<field>s are skipped in HTML output).
* docutils/writers/latex2e/__init__.py
- Fix placement of hyperlink target (label) for tables (bug #440).
- More compact LaTeX source for option-lists and description-lists
(no change in output).
* docutils/writers/manpage.py
- Put manual section in .TH in quotes.
- Skip footer to avoid the link to document source in the manpage.
- Add multiple definition list term support, see feature #60.
- Render reference, refid and refuri.
Use of ``.UR`` and ``.UE`` macros for reference markup is too brittle.
- Add preprocessor hinting tbl first line, see bug #477.
- Change tbl-Tables using box option, see bug #475.
- Apply literal block patch #205. Use ``.EE`` and ``.EX`` macros.
Thanks to G. Branden Robinson.
* docutils/writers/odf_odt/__init__.py
- Use context manager for image reading operations.
Catch `URLError` when `urllib.request.urlopen()` fails.
- Convert image URI to path if accessing a local file. Fixes bug #153.
* docutils/writers/s5_html/__init__.py
- Warn if the S5 writer cannot copy the theme files.
- Programmatic customization of theme_url_ setting no longer
overridden by the default for theme_.
* tools/buildhtml.py
- New configuration setting `sources`_.
- Match `prune`_ values with `fnmatch.fnmatch()`.
py-docutils: update to 0.20.1. Release 0.20.1 (2023-05-17) =========================== Bugfix release.
py-docutils: update to 0.20.
Release 0.20 (2023-05-09)
=========================
* General
- Docutils 0.20 is the last version supporting Python 3.7 and 3.8.
- Support Python 3.11 (patch #198 by Hugo van Kemenade).
* docutils/core.py
- New functions `rst2…()` for use as "console_scripts" `entry points`_.
(cf. `Future changes` in the RELEASE-NOTES_).
* docutils/frontend.py
- New configuration setting "output_". Obsoletes the ``<destination>``
positional argument (cf. `Future changes` in the RELEASE-NOTES_).
* docutils/languages/
docutils/parsers/rst/languages/
- Support Ukrainian. Patch by Dmytro Kazanzhy.
* docutils/nodes.py
- Fix `previous_sibling()` method that led to invalid HTML in some cases
(cf. patch #195).
- Fix bug #463. Spurious comma in deprecation warning.
* docutils/parsers/recommonmark_wrapper.py
- Improved mock Sphinx module.
* docutils/transforms/__init__.py
- `Transformer.populate_from_components()` now silently ignores
components that are not instances of `docutils.TransformSpec`.
* docutils/transforms/frontmatter.py
- Accept author names with initials like ``A. Einstein`` in the "author"
`bibliographic field`_ instead of rising an error
(generally, such names are `parsed as enumerated list`__).
.. _bibliographic field:
docs/ref/rst/restructuredtext.html#bibliographic-fields
__ docs/ref/rst/restructuredtext.html#enumerated-lists
* docutils/transforms/references.py
- `DanglingReferences` ignores `citation_reference` nodes if the
"use_bibex" setting is active. (In this case, citations are provided
by LaTeX/BibTeX.) Fixes bug #384.
* docutils/utils/__init__.py
- New utility function `xml_declaration()`.
- `DependencyList.add()` accepts `pathlib.Path` instances.
- `find_file_in_dirs()` now returns a POSIX path also on Windows;
`get_stylesheet_list()` no longer converts ``\`` to ``/``.
* docutils/utils/math/latex2mathml.py
- Support "mod" notation for modulo operation / modulus arithmetic.
* docutils/utils/math/tex2mathml_extern.py
- Support `Pandoc` as alternative LaTeX to MathML converter.
Patch by Ximin Luo.
* docutils/writers/_html_base.py
- Refactoring of `HTMLTranslator` initialization and collecting of
document "parts". Adapt HTML writers importing `_html_base`.
Changes to the HTML output (no space character before closing tag of
XML declaration, order of metadata elements)
don't affect the HTML semantics, styling, and rendering.
- Wrap definition lists with "details" class argument in a <div>
with the "id" and "class" values of the list node.
- Use dpub-ARIA role "doc-footnote__" (instead of ARIA role "note")
for footnotes.
__ https://www.w3.org/TR/dpub-aria-1.1/#doc-footnote
* docutils/writers/latex2e/__init__.py
- Do not load the `inputenc` package in UTF-8 encoded LaTeX sources.
(UTF-8 is the default encoding for LaTeX2e since 2018).
- Fix behaviour of the use_bibtex_ setting.
- Outsource parts of `depart_document()` to new auxiliary methods
`make_title()` and `append_bibliography()`.
- Ensure POSIX paths in stylesheet loading macros.
* docutils/writers/latex2e/titlepage.tex
- Drop ``\usepackage{fixltx2e}`` from template.
(Obsolete since 2015 and dropped from other templates in Docutils 0.14.)
* docutils/writers/manpage.py
- Do not output empty "manual" in ``.TH``.
* docutils/writers/xetex/__init__.py
- Ignore settings in the [latex2e writer] configuration file section.
Place common settings in section [latex writers].
* setup.py
- Fix SetuptoolsDeprecationWarning: ``Installing '' as data is deprecated``
by adding data directories to package_data.packages list.
* tox.ini
- Extracted flake8 configuration and moved to ``.flake8``.
- changedir to directory ``test`` to avoid path problems.
* test/
- Refactored tests to use common `unittest` idioms.
Fixes errors when running the test suite with ``python -m unittest``
or external test frameworks, such as Pytest_.
.. _pytest: https://pypi.org/project/pytest/
* test/coverage.sh
- Removed. Use the coverage.py_ project instead,
``coverage run test/alltests.py`` and ``coverage report``.
.. _coverage.py: https://pypi.org/project/coverage/
* tools/
- Moved ``quicktest.py`` to ``tools/dev/``.
py-docutils: avoid self-conflict
py-docutils: update to 0.19.
Release 0.19 (2022-07-05)
=========================
(Release 0.19b1 (2022-06-21))
* Drop support for Python 2.7, 3.5, and 3.6.
* Output changes:
HTML5:
Wrap groups of footnotes in an ``<aside>`` for easier styling.
The CSS rule ``.footnote-list { display: contents; }`` can be used to
restore the behaviour of custom CSS styles.
* After package installation, the CLI commands ``python -m docutils`` and
``docutils`` start the `generic command line front end tool`__.
__ docs/user/tools.html#generic-command-line-front-end
* Support parsing "Markdown" input with 3rd party parsers
myst_, pycmark_, or recommonmark_.
* The default values for the "pep-references", "rfc-base-url",
and "python-home" `configuration settings`_ now use the "https:" scheme.
The PEP-writer template's header is updated to fix links and
resemble the header of official PEPs.
* Various bugfixes and improvements (see HISTORY_).
.. _myst: https://pypi.org/project/myst-docutils
.. _pycmark: https://pypi.org/project/pycmark/
.. _recommonmark: https://pypi.org/project/recommonmark/
.. _configuration settings: docs/user/config.html
Release 0.18.1 (2021-12-23)
===========================
.. Note::
Docutils 0.18.x is the last version supporting Python 2.7, 3.5, and 3.6.
* ``nodes.Node.traverse()`` returns a list again to restore backwards
compatibility (fixes bug #431).
Use ``nodes.Node.findall()`` to get an iterator.
* re-add module ``parsers.rst.directives.html``
(stub, emits deprecation warning and loads
"Meta" directive from ist new place at ``parsers.rst.directives.misc``.)
* Small bugfixes (see HISTORY_).
Release 0.18 (2021-10-26)
=========================
* Output changes:
Identifiers:
- During `identifier normalization`_, leading number and hyphen
characters are no longer stripped from a `reference name`_, if the
id_prefix_ setting is non-empty.
Example:
with ``--id-prefix="DU-"``, a section with title "34. May"
currently gets the identifier key ``DU-may`` and after the
change the identifier key ``DU-34-may``.
- The default value for the auto_id_prefix_ setting changed to ``%``:
"use the tag name as prefix for auto-generated IDs".
Set auto_id_prefix_ to ``id`` for unchanged auto-IDs.
HTML5:
- Use the semantic tag <aside> for footnote text and citations, topics
(except abstract and toc), admonitions, and system messages.
Use <nav> for the Table of Contents.
- Make "auto" table column widths the default: Only specify column
widths, if the `"widths" option`_ is set and not "auto".
The table-style__ setting "colwidths-grid" restores the current default.
.. _"widths" option: __ docs/ref/rst/directives.html#table
__ docs/user/config.html#table-style
- Items of a definition list with class argument "details" are
converted to `details disclosure elements`_. Example::
..class:: details
Summary
This additional information should be hidden.
- Do not add "compound-first", "compound-middle", or "compound-last" to
elements nested in a compound. Use child selector and ":first-child",
":last-child" pseudo classes instead.
- Use class value "backrefs" instead of "fn-backref" for a span of
back-references.
- Write footnote brackets and field term colons to HTML, so that they
are present also without CSS and when copying text.
- Move space character between section number and heading into
"sectnum" span.
`math-output`_: html
- Support more commands, fix mapping of commands to Unicode characters.
- Scale variable sized operators and big delimiters with CSS.
- Don't use <tt> element (deprecated in HTML5).
- Use STIX fonts if available.
LaTeX:
`legacy_class_functions`_ setting default changed to "False",
admonitions are now environments.
* New standard Docutils doctree node: <meta__>.
* New configuration settings:
- [latex writers] legacy_column_widths_ and
- [html5 writer] image_loading_.
* Removed files:
``iepngfix.htc`` and ``blank.gif`` (IE 6 workaround for `s5_html`).
* Removed sub-module:
``parsers.rst.directives.html``
(reversed in release 0.18.1).
* Removed function: utils.unique_combinations()
(obsoleted by itertools.combinations()).
* Removed attributes:
- ``HTMLTranslator.topic_classes``: check ``node.parent.classes`` instead.
- ``nodes.Text.rawsource``: we store the null-escaped text in Text
nodes since 0.16 so there is no additional information in the
rawsource.
* Major refactoring and fixes/additions in
``docutils/utils/math/math2html.py`` and
``docutils/utils/math/latex2mathml.py``
(mathematical notation in HTML, cf. `LaTeX syntax for mathematics`_).
* nodes.Node.traverse() returns an iterator instead of a list
(reversed in release 0.18.1).
* Various bugfixes and improvements (see HISTORY_).
Fix spelling errors in documentation and docstrings.
Thanks to Dimitri Papadopoulos.
__ docs/ref/doctree.html#meta
.. _identifier normalization:
docs/ref/rst/directives.html#identifier-normalization
.. _id_prefix: docs/user/config.html#id-prefix
.. _auto_id_prefix: docs/user/config.html#auto-id-prefix
.. _details disclosure elements:
https://www.w3.org/TR/html52/interactive-elements.html#the-details-element
.. _LaTeX syntax for mathematics: docs/ref/rst/mathematics.html
.. _legacy_column_widths: docs/user/config.html#legacy-column-widths
py-docutils: downgraded to 0.17.1 - py-sphinx is not ready for 0.18 yet
py-docutils: updated to 0.18
Release 0.18 (2021-10-26)
=========================
* docutils/nodes.py
- Don't change a list while looping over it (in
document.set_name_id_map()). Thanks to Mickey Endito.
* docutils/parsers/recommonmark_wrapper.py
- Test and update to work with recommonmark version 0.6.0.
Still experimental.
Unfortunately, recommonmark_ is `no longer maintained`__.
__ https://github.com/readthedocs/recommonmark/issues/221
* docutils/parsers/rst/directives/misc.py
- Fix bug 424 Wrong circular inclusion detection.
Use a "magic" comment instead of line numbers
to keep a log of recursive inclusions.
* docutils/parsers/rst/states.py
- Use a "magic" comment to update the log of recursive inclusions.
* docutils/writers/html5_polyglot/__init__.py
- New option "image_loading". Support "lazy" loading of images.
Obsoletes "embed_images".
* docutils/writers/pseudoxml.py:
- Fix spelling of option "detailed".
* tools/docutils-cli.py
- Read settings from standard configuration files.
py-docutils: updated to 0.16
Release 0.16:
Docutils 0.15.x is the last version supporting Python 2.6, 3.3 and 3.4.
Docutils 0.16.x supports Python 2.7 and Python >= 3.5 natively,
without the use of the ``2to3`` tool.
* reStructuredText:
- Keep `backslash escapes`__ in the document tree. This allows, e.g.,
escaping of author-separators in `bibliographic fields`__.
* LaTeX writer:
- Informal titles of type "rubric" default to bold-italic and left aligned.
- Deprecate ``\docutilsrole`` prefix for styling commands:
use ``\DUrole`` instead.
- Fix topic subtitle.
- Add "latex writers" to the `config_section_dependencies`.
- Ignore classes for `rubric` elements
(class wrapper interferes with LaTeX formatting).
* tools/buildhtml.py
- New option "--html-writer" allows to select "html__" (default),
"html4" or "html5".
* docutils/io.py
- Remove the `handle_io_errors` option from io.FileInput/Output.
* docutils/nodes.py
- If `auto_id_prefix`_ ends with "%", this is replaced with the tag name.
* Various bugfixes and improvements (see HISTORY_).
py-docutils: updatede to 0.15.2
Release 0.15.2:
* docutils/nodes.py
- Fix 366: circular import when docutils nodes is iported before docutils.utils
by putting import docutils.utils into astext.
- Fix 366: as it is done in trunk Commit [r8294], moving the function.
Release 0.15:
* General
- Dropped support for Python 2.4, 2.5, 3.1, and 3.2.
- Infrastructure automation.
* docs/ref/rst/restructuredtext.txt:
- Document rST syntax change: Tokens like :this:example: are now valid
field list names (instead of ordinary text).
* docutils/io.py
- Fix [ 348 ] Since Python 3.4, the 'U' universal newlines mode has been
deprecated (thanks to hugovk).
* docutils/languages/la.py
docutils/parsers/rst/languages/la.py:
- Apply [ 153 ] Korean mappings by Thomas Sungjin Kang.
* docutils/nodes.py
- Fix [ 251 ] system_message.copy() TypeError.
- Element.copy() also copies document, line, and source attributes.
* docutils/parsers/rst/__init__.py:
- Apply [ 152 ] reset default role at end of document.
* docutils/parsers/rst/states.py:
- Allow embedded colons in field list field names.
- Add rawsource attribute for text of inline elements.
* docutils/parsers/rst/directives/html.py:
- Fix bug 281: Remove escaping backslashes in meta directive content.
* docutils/parsers/rst/directives/misc.py:
- Don't convert tabs to spaces, if tab_width is negative in
include directive with code option.
* 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.
* docutils/transforms/references.py:
- Fix bug 331: fixed the "trim" options of the "unicode" directive.
* docutils/utils/__init__.py:
- Deprecate unique_combinations (obsoleted by itertools.combinations).
* 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/_html_base.py
- Fix bug 358: Non-breaking space removed from fixed-width literal.
* docutils/writers/latex2e/__init__.py:
- Fix bug 323: spurious \phantomsection and whitespace in
parts['title'].
- Fix bug 324: Invalid LaTeX for table with empty multicolumn cell.
- Fixes to literal block handling.
Release 0.14:
As rc2.
* docutils/docs/ref/docutils.dtd:
- Enable validation of Docutils XML documents against the DTD:
* docutils/parsers/rst/:
- Added functionality: escaped whitespace in URI contexts.
- Consistent handling of all whitespace characters in inline markup
recognition. (May break documents that relied on some whitespace
characters (NBSP, ...) *not* to be recognized as whitespace.)
* docutils/utils/smartquotes.py:
- Update quote definitions for et, fi, fr, ro, sv, tr, uk.
- Add quote definitions for hr, hsb, hu, lv, sh, sl, sr.
- Differentiate apostrophe from closing single quote (if possible).
- Add command line interface for stand-alone use (requires 2.7).
* docutils/writers/_html_base:
- Provide default title in metadata.
- 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.
See math-output_ for details.
* docutils/writers/html4css1:
- 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/odf_odt:
- Language option sets ODF document's default language
- Image width, scale, ... set image size in generated ODF.
* tools/
- New front-end ``rst2html4.py``.
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/
- New HTML writer generating clean, polyglot_ markup conforming to
`HTML 5`_.
The CSS stylesheets ``minimal.css`` and ``plain.css`` contain required
and recommended layout rules.
* 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`` and ``default_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 with 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.
.. _polyglot: http://www.w3.org/TR/html-polyglot/
.. _HTML 5: http://www.w3.org/TR/html5/
.. _XHTML 1.0: http://www.w3.org/TR/xhtml1/
Update to 0.12
Also use ALTERNATIVES framework to allow concurrent installation under
multiple pythons.
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.
Update to 0.11:
Release 0.11 (2013-07-22)
=========================
* General
- 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/parsers/rst/directives/tables.py
- Fix [ 210 ] Python 3.3 checks CVS syntax only if "strict" is True.
* docutils/writers/html4css1/__init__.py
- Fix [ 3600051 ] for tables in a list, table cells are not compacted.
- New setting `stylesheet_dirs` (see above).
Now, it is easy to add a custom stylesheet to Docutils' default
stylesheet with, e.g., ``--stylesheet_path='html4css1.css, mystyle.css'``
Changed behaviour of the default settings:
if there is a file ``html4css1.css`` in the working directory of the
process at launch, it is used instead of the one provided by Docutils
in the writer source directory.
- New default for math-output_: ``HTML math.css``.
- Avoid repeated class declarations in html4css1 writer
(modified version of patch [ 104 ]).
.. _math-output: docs/user/config.html#math-output
* 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.
- New setting `stylesheet_dirs`: Comma-separated list of directories
where stylesheets are found. Used by `stylesheet_path` when expanding
relative path arguments.
.. _SmartQuotes: docs/user/config.html#smart-quotes
* docutils/writers/manpage.py
- Fix [3607063] handle lines starting with a period.
- Fix option separating comma was bold (thanks to Bill Morris).
Update py-docutils to 0.10. Resolves PR pkg/47372. From RELEASE-NOTES:
Docutils 0.10 is compatible with Python versions from 2.4 to 3.2.
General:
SmartQuotes transform for typographic quotes and dashes.
docutils/math, docutils/error_reporting.py, and docutils/urischemes.py moved to the utils package. Code importing these modules needs to adapt, e.g.:
try:
import docutils.math as math
except ImportError:
import docutils.utils.math as math
enhanced math and error handling.
docutils/io.py
FileInput/FileOutput: no system-exit on IOError. The handle_io_errors option is ignored.
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/latex2e/__init__.py, docutils/writers/xetex/__init__.py
Fix section numbering by LaTeX.
docutils/writers/s5_html/__init__.py
Fix [ 3556388 ] Mathjax does not work with rst2s5.
apply missing the first hunk of the patch for PLIST in PR 46573.
Update to version 0.9 Closes PR 46573
All supported python versions in pkgsrc support eggs, so remove
${PLIST.eggfile} from PLISTs and support code from lang/python.
Update py-docutils to 0.8.1.
While here,
* register egg-info.
* switch to use external roman.py module.
* set LICENSE.
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).
* docutils/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`` and ``math_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.
.. _BCP 47: http://www.rfc-editor.org/rfc/bcp/bcp47.txt
.. _COPYING: COPYING.html
* 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.
Update to 0.6:
* 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`` and ``end-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`` as ``bp`` in LaTeX.
- Do not convert ``px`` to ``pt`` (``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
Remove @dirrm entries from PLISTs
Update to 0.5:
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`` and ``strip_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`` and ``end-before`` options to ``include``
directive; thanks to Stefan Rank.
* docutils/transforms/universal.py:
- Added ``StripClassesAndElements`` transform to remove from the
document tree all elements with classes in
``settings.strip_elements_with_classes`` and all "classes"
attribute values in ``self.document.settings.strip_classes``.
* docutils/transforms/writer_aux.py:
- Added ``Admonitions`` transform to transform specific admonitions
(like ``note``, ``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 surrounding ``div``
elements.
- Dropped all ``name`` attributes of ``a`` 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 to ``pt``.
- Add image height support.
- Fix: image width ``70%`` is converted ``0.700\linewidth``.
bug #1457388
- Fix: 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``).
* 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`` and ``rst-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.
Convert to use PLIST_VARS instead of manually passing "@comment " through PLIST_SUBST to the plist module.
Fix PLIST. Bump revision.
Update docutils to 0.4 Components: * Added an S5/HTML writer and the rst2s5.py front end: multi-platform, multi-browser HTML slide shows. * The newlatex2e writer is nearing completion. * Added a DocTree reader, publish_doctree and publish_from_doctree convenience functions, for document tree extraction and reprocessing. reStructuredText: * Added directives: "container" (generic block-level container), "default-role" (role used for `backtick` syntax), "title" (document title metadata), and "date" (generate the current local date, for substitution definitions). * Length units are now supported for image sizes. * Added standard definition files for special characters etc. Internationalization: * Added Japanese and Simplified Chinese language mappings, and support for double-width CJK-characters in tables and section titles. Documentation: * Added a guide for distributors (package maintainers) and a guide for developers. General: * Added significant Emacs support for reST. * Added a --strip-comments option. * --embed-stylesheet is now the default for the HTML writer (rather than --link-stylesheet).
Add missing installed files. No functional change so no PKGREVISION bump.
Upgrade to 0.3.9 Major Changes Since Docutils 0.3.7 ================================== * Added "file_insertion_enabled" and "raw_enabled" settings. See <http://docutils.sf.net/docs/user/config.html#file-insertion-enabled>. * Added auto-enumerated lists. See <http://docutils.sf.net/docs/ref/rst/restructuredtext.html#enumerated-lists>. * Added "header" and "footer" directives. See <http://docutils.sf.net/docs/ref/rst/directives.html#document-header-footer>. * Added "list-table" directive. See <http://docutils.sf.net/docs/ref/rst/directives.html#list-table>. * Added support for section subtitles. See <http://docutils.sf.net/docs/user/config.html#sectsubtitle-xform>. * Added "field_name_limit" and "option_limit" settings to HTML writer. See <http://docutils.sf.net/docs/user/config.html#field-name-limit>. * Added "cloak_email_addresses" setting to HTML writer. See <http://docutils.sf.net/docs/user/config.html#cloak-email-addresses>. * UTF-8 BOMs are now removed from the input stream. * Many minor improvements and bug fixes. See <http://docutils.sf.net/HISTORY.html#release-0-3-9-2005-05-26
Fix PLIST. Bump PKGREVISION.
update to 0.3.5 Major changes: * improved, extended and reorganized documentation; see http://docutils.sourceforge.net/docs/ * new cvs-table directive * many minor improvements, additions and bug fixes For a detailed list see: http://docutils.sourceforge.net/0.3.5/HISTORY.html
Some modules are not installed for python 2.3. This closes PR pkg/23800. Approved by wiz@.
Add some missing entries
update to 0.3
changes:
General:
* Renamed "attribute" to "option" for directives/extensions.
* Renamed transform method "transform" to "apply".
* Renamed "options" to "settings" for runtime settings (as set by
command-line options). Sometimes "option" (singular) became
"settings" (plural). Some variations below:
- document.options -> document.settings (stored in other objects as
well)
- option_spec -> settings_spec (not directives though)
- OptionSpec -> SettingsSpec
- cmdline_options -> settings_spec
- relative_path_options -> relative_path_settings
- option_default_overrides -> settings_default_overrides
- Publisher.set_options -> Publisher.get_settings
for the "Specific" changes see HISTORY.txt.
Initial import of py-docutils-0.2. The purpose of the Docutils project is to create a set of tools for processing plaintext documentation into useful formats, such as HTML, XML, and TeX.
Initial revision