Skip to content

Please test changes and new features in Docutils 0.22. #13656

Open
@gmilde

Description

@gmilde

The Docutils pre-release 0.22.rc3 is available on pypi https://pypi.org/project/docutils/0.22rc3/.

The Sphinx test suite includes a test with Docutils HEAD, so the basics should work.
@AA-Turner are there still inverted tests (expected to fail) from #13539 or are all test cases returned to normal?

The Sphinx LaTeX writer worked around the recent regression (#13609

However, there are backwards incompatible changes and new features that warrant additional tests:

  • reStructuredText now support CSS3 units. This adds “ch”, “rem”, “vw”, “vh”, “vmin”, “vmax”, and “Q” to the supported length units. Note that some output formats don’t support all units.
    @jfbu: Check Docutils commit r9943 for the LaTeX writer support in Docutils.

  • Allow multiple <term> elements in a <definition_list_item> (third-party writers may need adaption).
    (Some Sphinx extensions already produce this. There is currently no way to create a mulit-term definition list entry with rST. A sample may be constructed programatically or with the new XML parser.)

  • Rename configuration setting “output” to “output_path”.

  • HTML5: Unitless image_ size measures are written as <img> "width" and
    "hight" values instead of "style" rules.

  • The new Docutils-XML parser may need adaption to work with element types added by Sphinx.

  • The Document Model (doctree) can now be validated with the nodes.Element.validate() method or the validate configuration setting. This may require addiing descriptors for supported attributes and children to Sphinx-specific doctree elements.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docutilsTags upstream Docutils issuestype:proposala feature suggestion

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions