Activity for Docutils: Documentation Utilities

Günter Milde committed [r10312] on Code

Günter Milde — Fri, 17 Apr 2026 17:54:17 -0000

Ensure and test backwards compatible auto-id-prefix behaviour.

Günter Milde modified ticket #518

Günter Milde — Fri, 17 Apr 2026 08:48:41 -0000

id_prefix removes footnote prefix from

Günter Milde posted a comment on ticket #518

Günter Milde — Fri, 17 Apr 2026 08:48:41 -0000

Fine. The updates are now also at https://docutils.sourceforge.io/docs/, so I'll close this issue. Thanks again for reporting.

miketheman posted a comment on ticket #518

miketheman — Fri, 10 Apr 2026 13:22:07 -0000

I think those changes make it clearer, thanks!

Günter Milde posted a comment on ticket #518

Günter Milde — Fri, 10 Apr 2026 07:43:15 -0000

Is there something to change in SF classification to make this a documentation issue vs bug? Classing the report as bug report is IMO correct, defining the problem as a documentation issue should help to address it. Would the changes in [r10310] and [10311] have prevented the "wrong feeling"? (It will take some time to get them into the published documentation at https://docutils.sourceforge.io/docs/.)

Günter Milde committed [r10311] on Code

Günter Milde — Fri, 10 Apr 2026 07:39:13 -0000

Small documentation fixes.

Günter Milde committed [r10310] on Code

Günter Milde — Fri, 10 Apr 2026 06:56:11 -0000

Amend documentation of the "identifier normalization".

Günter Milde posted a comment on ticket #89

Günter Milde — Thu, 09 Apr 2026 18:40:37 -0000

I'd like to finalise/close this issue and apply the proposed API definition and backwards policy Commit [r10309] updated the proposal EP 10. Unless someone objects, I'd apply the attached patch in 4 weeks to ship with Docutils 0.23. After this, Docutils will switch "semantic versioning".

Günter Milde committed [r10309] on Code

Günter Milde — Thu, 09 Apr 2026 14:35:56 -0000

Dcumentation update.

miketheman posted a comment on ticket #518

miketheman — Sat, 28 Mar 2026 20:10:33 -0000

Thanks for looking into it. It felt wrong enough to raise it here. Is there something to change in SF classification to make this a documentation issue vs bug?

Günter Milde committed [r10308] on Code

Günter Milde — Sat, 28 Mar 2026 18:54:26 -0000

More tests with "legacy_ids = False".

Günter Milde committed [r10307] on Code

Günter Milde — Sat, 28 Mar 2026 18:54:16 -0000

Add "SectionIDs" transform in standalone reader.

Günter Milde committed [r10306] on Code

Günter Milde — Sat, 28 Mar 2026 18:54:07 -0000

Move "legacy_ids" setting to generic [parsers] config section.

Günter Milde modified a comment on ticket #518

Günter Milde — Fri, 27 Mar 2026 22:24:32 -0000

Thank you for the report. I would classify the problem as a documentation issue rather than a bug. The problem is the difference between a reference name and an identifier . Identifiers are derived from reference names via the identifier normalization. In HTML4 (one of our supported output formats) a reference name may not start with a digit. Hence, a reference name consisting of only digits "vanishes completely" unless prefixed. (cf. https://sourceforge.net/p/docutils/feature-requests/66/). This...

Günter Milde modified a comment on ticket #518

Günter Milde — Fri, 27 Mar 2026 22:19:53 -0000

Günter Milde committed [r10305] on Code

Günter Milde — Fri, 27 Mar 2026 21:45:54 -0000

Drop spurious back references from system messages.

Günter Milde committed [r10304] on Code

Günter Milde — Fri, 27 Mar 2026 08:41:26 -0000

Use "matching identifiers" in some functional tests.

Günter Milde committed [r10303] on Code

Günter Milde — Fri, 27 Mar 2026 08:41:12 -0000

Generate identifiers for sections and ToC in transforms.

Günter Milde committed [r10302] on Code

Günter Milde — Fri, 27 Mar 2026 08:40:59 -0000

Improve handling of duplicate reference names.

Günter Milde committed [r10301] on Code

Günter Milde — Thu, 26 Mar 2026 13:52:29 -0000

New configuration setting "legacy_ids".

Günter Milde posted a comment on ticket #518

Günter Milde — Tue, 24 Mar 2026 17:23:01 -0000

Thank you for the report. I'd classify the problem as a documentation issue rather than a bug. The problem is the difference between an reference name and an identifier . Identifiers are derived from reference names via the identifier normalization. Due to identifier restriction in HTML4, a reference name consisting of only digits "vanishes completely" unless prefixed. (cf. https://sourceforge.net/p/docutils/feature-requests/66/). This is why the reference-name "5" is replaced by the auto-generated...

miketheman created ticket #518

miketheman — Sun, 22 Mar 2026 00:40:04 -0000

id_prefix removes footnote prefix from

Günter Milde modified a comment on ticket #207

Günter Milde — Mon, 16 Mar 2026 11:18:45 -0000

Superseded by the more generic approach discussed in [feature-requests:#66].

Günter Milde modified a comment on ticket #207

Günter Milde — Mon, 16 Mar 2026 11:14:29 -0000

Superseded by the more generic approach discussed in [Feature Requests:#66].

Günter Milde modified a comment on ticket #207

Günter Milde — Mon, 16 Mar 2026 11:13:04 -0000

Superseded by the more generic approach discussed in [feature-requests:#66].

Günter Milde committed [r10300] on Code

Günter Milde — Fri, 06 Feb 2026 09:09:29 -0000

Fix `Transition` post-processing transform.

Günter Milde committed [r10299] on Code

Günter Milde — Fri, 06 Feb 2026 09:09:20 -0000

Fix nodes.transition.validate_position()

Günter Milde committed [r10298] on Code

Günter Milde — Fri, 06 Feb 2026 09:09:13 -0000

Re-sort class definitions in nodes.py.

Günter Milde committed [r10297] on Code

Günter Milde — Fri, 06 Feb 2026 09:09:05 -0000

Update various comments and docstrings.

Günter Milde committed [r10296] on Code

Günter Milde — Fri, 06 Feb 2026 09:08:59 -0000

Simplify check if its valid to insert a system_message.

Günter Milde committed [r10295] on Code

Günter Milde — Thu, 05 Feb 2026 21:27:03 -0000

"Directives" documentation: Correct the matrix of supported image formats.

Günter Milde modified ticket #216

Günter Milde — Sun, 25 Jan 2026 14:15:44 -0000

Fix type annotation for get_default_settings

Günter Milde posted a comment on ticket #216

Günter Milde — Sun, 25 Jan 2026 14:15:43 -0000

Applied in [r10294]. Thank you for the patch.

Günter Milde committed [r10294] on Code

Günter Milde — Sun, 25 Jan 2026 14:12:58 -0000

Fix type annotation for get_default_settings()

Dmitry Shachnev created ticket #216

Dmitry Shachnev — Thu, 22 Jan 2026 09:04:36 -0000

Fix type annotation for get_default_settings

Günter Milde committed [r10293] on Code

Günter Milde — Wed, 21 Jan 2026 15:18:35 -0000

Fix :number-lines: option of the "include" directive.

Günter Milde committed [r10292] on Code

Günter Milde — Thu, 15 Jan 2026 22:33:56 -0000

Update .htaccess web configuration file

Günter Milde committed [r10291] on Code

Günter Milde — Wed, 14 Jan 2026 20:46:07 -0000

HTML5 writer: Use the last "ids" value for the section-self-link.

Günter Milde posted a comment on ticket #516

Günter Milde — Sun, 11 Jan 2026 19:54:48 -0000

Commit [r10290] updates the FAQ answer to document the 3rd party entry "text/prs.fallenstein.rst"

Günter Milde committed [r10290] on Code

Günter Milde — Sun, 11 Jan 2026 19:35:52 -0000

Update FAQ answer about MIME type.

Günter Milde posted a comment on ticket #516

Günter Milde — Fri, 09 Jan 2026 17:40:57 -0000

The author/change controller writes in the registration: If anybody more intimately involved with ReStructuredText wants to take it over, it will be surrendered gladly. We may consider taking over as "change controller" and keep the name as text/prs.fallenstein.rst (never touch a running system), change the name to text/prs.docutils.rst (simple registration in the Personal Registration Tree), or try to register as text/rst (official registry, requires publication of an RFC)

Felix Fontein posted a comment on ticket #517

Felix Fontein — Wed, 07 Jan 2026 20:23:32 -0000

Thanks for fixing this, I can confirm that with the latest commit it works fine (except tables lists, as you mentioned - but these are not very common, at least the ones with code blocks in them :) )! I'm using the line numbers to try to identify the exact position of the code block (including its column offset), mainly for two use-cases: 1. Being able to show more precise error locations when linting code in code blocks; 2. To be able to replace code block content's with output (extracted from running...

Günter Milde committed [r10289] on Code

Günter Milde — Wed, 07 Jan 2026 13:43:03 -0000

Small documentation updates.

Günter Milde committed [r10288] on Code

Günter Milde — Wed, 07 Jan 2026 13:42:54 -0000

Doctree documentation: Include entity definitions from ``docutils.dtd``.

Günter Milde committed [r10287] on Code

Günter Milde — Wed, 07 Jan 2026 13:41:01 -0000

Use name of custom role based on "code" as its language default.

Günter Milde committed [r10286] on Code

Günter Milde — Wed, 07 Jan 2026 13:40:47 -0000

nodes.Element.findall() now accepts also a tuple of types as condition.

Günter Milde modified a comment on ticket #517

Günter Milde — Wed, 07 Jan 2026 13:17:30 -0000

Line numbers are still wrong in the nested parsing of cell content in "CSV tables". Generally, source line numbers are only intended for ease of debugging and should not be relied upon too heavily.

Günter Milde posted a comment on ticket #517

Günter Milde — Wed, 07 Jan 2026 13:16:58 -0000

Line numbers are still wrong in the nested parsing of cell content in "CSV tables". Generally, the line numbers are only intended for ease of debugging and should not be relied upon too heavily.

Günter Milde modified a comment on ticket #517

Günter Milde — Wed, 07 Jan 2026 13:14:25 -0000

The fix is out. Sorry for the confusion: I intended to publish 2 commits with one git svn dcommit but there was a timeout after the first :(

Günter Milde modified ticket #517

Günter Milde — Wed, 07 Jan 2026 13:13:48 -0000

content_offset in directives inside grid/simple tables are off

Günter Milde posted a comment on ticket #517

Günter Milde — Wed, 07 Jan 2026 13:13:48 -0000

The fix is out. Sorry for the confusion: I intended to publish 2 commits with one git svn dcommit but only the first came through.

Günter Milde modified a comment on ticket #517

Günter Milde — Wed, 07 Jan 2026 13:10:12 -0000

Thanks for the test script. The attached variant was used to explore the problem and find the spot that needs to be changed. The upcoming commit [r10280] will fix the problem (and also wrong line numbers in some system messages for markup errors inside table cells.

Günter Milde committed [r10285] on Code

Günter Milde — Wed, 07 Jan 2026 07:52:50 -0000

Move LaTeX styling for "html-roles" definitions to docutils.sty.

Günter Milde committed [r10284] on Code

Günter Milde — Wed, 07 Jan 2026 07:52:29 -0000

LaTeX writer: don't write labels for implicit IDs that are not referenced.

Günter Milde committed [r10283] on Code

Günter Milde — Wed, 07 Jan 2026 07:52:11 -0000

More relaxed "include" directive.

Günter Milde committed [r10282] on Code

Günter Milde — Wed, 07 Jan 2026 07:51:50 -0000

Remove obsolete method in CSVTable directive class.

Günter Milde committed [r10281] on Code

Günter Milde — Wed, 07 Jan 2026 07:51:39 -0000

Bump version to 0.23b.dev

Günter Milde committed [r10280] on Code

Günter Milde — Wed, 07 Jan 2026 07:51:18 -0000

Fix "input_offset" in tables.

Felix Fontein posted a comment on ticket #517

Felix Fontein — Tue, 06 Jan 2026 20:59:23 -0000

Oh sorry, I missed the part on "upcoming commit"... I thought the commit you added earlier today (r10279) already fixed the issue...

Felix Fontein posted a comment on ticket #517

Felix Fontein — Tue, 06 Jan 2026 20:57:39 -0000

Thanks for looking into this! Unfortunately with your patch, the result of my test script seems unchanged. This change fixes the issue for me, but I'm not sure whether it is correct: --- a/docutils/docutils/parsers/rst/states.py +++ b/docutils/docutils/parsers/rst/states.py @@ -1950,7 +1950,7 @@ def build_table_row(self, rowdata, tableline): entry = nodes.entry(**attributes) row += entry if ''.join(cellblock): - self.nested_parse(cellblock, input_offset=tableline+offset, + self.nested_parse(cellblock,...

Günter Milde modified a comment on ticket #517

Günter Milde — Tue, 06 Jan 2026 20:30:45 -0000

Günter Milde modified ticket #517

Günter Milde — Tue, 06 Jan 2026 20:29:12 -0000

content_offset in directives inside grid/simple tables are off

Günter Milde modified a comment on ticket #517

Günter Milde — Tue, 06 Jan 2026 20:28:58 -0000

Thanks for the test script. The attached variant was used to explore the problem and find the spot that needs to be changed. Commit [r10280] fixes the problem (and also wrong line numbers in some system messages for markup errors inside table cells.

Günter Milde modified ticket #517

Günter Milde — Tue, 06 Jan 2026 17:35:28 -0000

content_offset in directives inside grid/simple tables are off

Günter Milde posted a comment on ticket #517

Günter Milde — Tue, 06 Jan 2026 17:35:05 -0000

Thanks for the test script. The attached variant was used to explore the problem and find the spot that needs to be changed. Commit [r10279] fixes the problem (and also wrong line numbers in some system messages for markup errors inside table cells.

Günter Milde committed [r10279] on Code

Günter Milde — Tue, 06 Jan 2026 17:29:55 -0000

Add internal source and line attributes to "rubric" and "table" nodes.

Felix Fontein posted a comment on ticket #517

Felix Fontein — Thu, 01 Jan 2026 20:42:25 -0000

I've attached a small script which shows the problem. It shows the line indicated by self.content_offset surrounded by some source lines for every code block. Like here you can see that content_offset is correct outside a table: 1 '' 2 '.. code-block:: yaml' 3 '' -> 4 ' - foo' 5 '' 6 'content_offset is off by 1:' 7 '' And here it is off by one when inside a grid table: 9 '| .. code-block:: yaml |' 10 '| |' 11 '| - foo |' -> 12 '+----------------------+' 13 '' 14 'content_offset is off by 2:' 15 ...

Günter Milde posted a comment on ticket #517

Günter Milde — Wed, 31 Dec 2025 11:34:11 -0000

Thank you for the report. Could you attach your test-directive, so that I can experiment and try a fix?

Felix Fontein created ticket #517

Felix Fontein — Sat, 27 Dec 2025 17:07:27 -0000

content_offset in directives inside grid/simple tables are off

Günter Milde modified ticket #514

Günter Milde — Fri, 19 Dec 2025 08:29:47 -0000

publish_file no longer works with "BytesIO-like" objects.

Günter Milde posted a comment on ticket #514

Günter Milde — Fri, 19 Dec 2025 08:29:47 -0000

Fixed in Docutils 0.22.4. Thank you for analysis and report.

engelbert gruber committed [r10278] on Code

engelbert gruber — Thu, 18 Dec 2025 19:35:40 -0000

release 0.22.4

engelbert gruber committed [r10277] on Code

engelbert gruber — Thu, 18 Dec 2025 19:31:36 -0000

release 0.22.5b1.dev

Docutils: Documentation Utilities released /docutils/0.22.4/README.rst

Docutils: Documentation Utilities — Thu, 18 Dec 2025 19:25:05 -0000

Docutils: Documentation Utilities released /docutils/0.22.4/docutils-0.22.4.tar.gz

Docutils: Documentation Utilities — Thu, 18 Dec 2025 19:24:04 -0000

engelbert gruber committed [r10276] on Code

engelbert gruber — Thu, 18 Dec 2025 18:56:46 -0000

tagging release 0.22.4

engelbert gruber committed [r10275] on Code

engelbert gruber — Thu, 18 Dec 2025 18:44:57 -0000

release 0.22.4

Günter Milde committed [r10274] on Code

Günter Milde — Wed, 17 Dec 2025 10:38:59 -0000

Finalise documentation of changes for 0.22.4.

Günter Milde modified a comment on ticket #516

Günter Milde — Tue, 16 Dec 2025 17:42:16 -0000

Thank you for the information. According to the IANA entry, Benja Fallenstein registered the "rst" MIME type because: The registrant just happened to have need of a registered media type for it. --- https://www.iana.org/assignments/media-types/text/prs.fallenstein.rst So the actual error is not the quoted part of the FAQ answer, but ... there is no registered MIME type for reStructuredText, .... It seems that with the switch of the source file extension from ".txt" to ".rst" in August 2024 some applications...

Günter Milde committed [r10273] on Code

Günter Milde — Tue, 16 Dec 2025 17:39:51 -0000

Günter Milde posted a comment on ticket #101

Günter Milde — Mon, 15 Dec 2025 11:32:51 -0000

Suggestion: Introduce a new Doctree element in Docutils 1.0 add "br" to docutils.dtd and document it in https://docutils.sourceforge.io/docs/ref/doctree.html add new class docutils.nodes.line_break add visit_line_break() and depart_line_break() methods to Docutils writers. New standard directive line-break. Similar to "replace", "date", and "unicode", this directive may only be used in substitution definitions, e.g. .. |br| .. line-break:: I want a line break\ |br| before this text....

Günter Milde posted a comment on ticket #516

Günter Milde — Mon, 15 Dec 2025 10:23:33 -0000

Thank you for the information. According to the IANA entry, Benja Fallenstein registered the "rst" MIME type because: The registrant just happened to have need of a registered media type for it. --- https://www.iana.org/assignments/media-types/text/prs.fallenstein.rst So the actual error is not the quoted part of the FAQ answer, but ... there is no registered MIME type for reStructuredText, .... It seems that with the switch of the source file extending from ".txt" to ".rst" in August 2024 some applications...

Günter Milde modified ticket #515

Günter Milde — Mon, 15 Dec 2025 10:02:48 -0000

Wrong statement in "reStructuredText Specification"

Günter Milde posted a comment on ticket #515

Günter Milde — Mon, 15 Dec 2025 10:02:47 -0000

Fixed in [r10271].

Ulrich Müller created ticket #516

Ulrich Müller — Mon, 15 Dec 2025 07:26:01 -0000

FAQ says MIME type for rst is text/x-rst but its source page is served as text/prs.fallenstein.rst

Günter Milde committed [r10272] on Code

Günter Milde — Sun, 14 Dec 2025 13:21:02 -0000

Documentation update

Günter Milde committed [r10271] on Code

Günter Milde — Sun, 14 Dec 2025 11:03:09 -0000

Fix statement in rST Specification example.

Günter Milde modified a comment on ticket #66

Günter Milde — Sun, 14 Dec 2025 10:20:46 -0000

See also the discussion in Sphinx issue #8709. Use case: Changelogs of "pip" and "black" use version numbers as section titles: the auto-generated IDs are not stable but may change if a new section is inserted :( Workaround: use explicit targets starting with a letter like "v25.1.1" (this is what "pip" does). This works in Sphinx. In Docutils, the "self-link" uses ids[0] which is the auto-generated one. This will be solved in Docutils 0.23.

Günter Milde committed [r10270] on Code

Günter Milde — Wed, 03 Dec 2025 11:38:57 -0000

New value "auto" for "initial_header_level" config setting.

Günter Milde committed [r10269] on Code

Günter Milde — Tue, 02 Dec 2025 19:48:49 -0000

Announce upcoming changes.

Günter Milde committed [r10268] on Code

Günter Milde — Tue, 02 Dec 2025 19:48:45 -0000

More detailled description of the restrictions on transition placement.

Günter Milde posted a comment on ticket #515

Günter Milde — Tue, 02 Dec 2025 10:48:41 -0000

Proposed patch: -- a/docutils/docs/ref/rst/restructuredtext.rst +++ b/docutils/docs/ref/rst/restructuredtext.rst @@ -179,7 +179,10 @@ Here are examples of `body elements`_: - Footnotes_:: .. [1] A footnote contains body elements, consistently - indented by at least 3 spaces. + indented by at least 1 space. + + The least indented line sets the reference + indentation, so this is a nested block quote. - Citations_:: The attached patch also adds some more examples and moves the paragraph about paragraph...

Günter Milde created ticket #515

Günter Milde — Tue, 02 Dec 2025 10:45:20 -0000

Wrong statement in "reStructuredText Specification"

Günter Milde committed [r10267] on Code

Günter Milde — Tue, 02 Dec 2025 09:38:49 -0000

docutils.io.FileInput: ensure read() returns a `str`.

Günter Milde modified ticket #514

Günter Milde — Mon, 01 Dec 2025 23:14:02 -0000

publish_file no longer works with "BytesIO-like" objects.

Günter Milde posted a comment on ticket #514

Günter Milde — Mon, 01 Dec 2025 22:44:36 -0000

Thank you for the report. The issue is fixed in [r10267].

Günter Milde modified ticket #128

Günter Milde — Mon, 01 Dec 2025 12:12:05 -0000

combining unicode chars count in grid tables

Günter Milde posted a comment on ticket #128

Günter Milde — Mon, 01 Dec 2025 12:12:05 -0000

Fixed in Docutils 0.22.3.

Günter Milde modified ticket #512

Günter Milde — Mon, 01 Dec 2025 12:10:12 -0000

rst2html incorrectly converts tables with Combining Diacritical Marks into HTML