docutils-develop — For developer discussions of the implementation.

[Docutils-develop] [docutils:feature-requests] #101 New "doctree" element for hard line breaks.

[Günter M. <mi...@us...>]

Suggestion:

Introduce a new Doctree element `<line_break>` 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](https://docutils.sourceforge.io/docs/ref/rst/directives.html) `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.
~~~
@aa-turner what do you think?


---

**[feature-requests:#101] New "doctree" element for hard line breaks.**

**Status:** pending-moreinfo
**Group:** Default
**Created:** Tue Dec 12, 2023 08:16 PM UTC by Günter Milde
**Last Updated:** Mon Apr 28, 2025 08:21 PM UTC
**Owner:** nobody


Not providing for "hard line break elements" in the Docutils document model and reStructuredText syntax was a deliberate decision at the time these two were devised.

However, times have changed and there are new arguments and use-cases for hard line breaks.
(cf.  the  [comments in #85](https://sourceforge.net/p/docutils/feature-requests/85/#d02b)).
Something like a `<br>` inline node or special handling of `<inline class=line-break>` inline nodes may be considered. The latter would not change the document model and could be implemented at the writer level or via stylesheet rules.

Whether to add a reStructuredText syntax for hard line breaks can be decided independently.
The current rules require a non-white character in a role defined with `.. role:: line-break`.
    



---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/feature-requests/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/feature-requests/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #516 FAQ says MIME type for rst is text/x-rst but its source page is served as text/prs.fallenstein.rst

[Günter M. <mi...@us...>]

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 started to use the registered MIME type when serving or analysing the source files.


---

**[bugs:#516] FAQ says MIME type for rst is text/x-rst but its source page is served as text/prs.fallenstein.rst**

**Status:** open
**Created:** Mon Dec 15, 2025 07:26 AM UTC by Ulrich Müller
**Last Updated:** Mon Dec 15, 2025 07:26 AM UTC
**Owner:** nobody


The Docutils FAQ says in section 2.24 https://docutils.sourceforge.io/FAQ.html#what-s-the-official-mime-type-for-restructuredtext-data:

> [...] the "official unofficial" standard MIME type is "text/x-rst".

However, when following the "View document source" at the bottom of the page, I get a different MIME type:
~~~
$ curl -I https://docutils.sourceforge.io/FAQ.rst
HTTP/2 200 
date: Mon, 15 Dec 2025 07:20:49 GMT
content-type: text/prs.fallenstein.rst
[...]
~~~
Clearly, this is not what the FAQ says.



---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #515 Wrong statement in "reStructuredText Specification"

[Günter M. <mi...@us...>]

- **status**: open --> closed-fixed
- **Comment**:

Fixed in [r10271].



---

**[bugs:#515] Wrong statement in "reStructuredText Specification"**

**Status:** closed-fixed
**Labels:** Documentation 
**Created:** Tue Dec 02, 2025 10:45 AM UTC by Günter Milde
**Last Updated:** Tue Dec 02, 2025 10:48 AM UTC
**Owner:** nobody


The rST specification states in one example that
"A footnote contains body elements, consistently indented by at least 3 spaces."
The minimal indentation in rST is one space.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] Towards Docutils 1.0

[Guenter M. <mi...@us...>]

Dear Docutils developers,

after Docutils release 0.22.3 solved incompatibilities with some Sphinx
extensions, the new `stable Sphinx`__ officially works with 

  docutils>=0.20,<0.23

__ https://pypi.org/project/Sphinx/


My ideas for the next steps are

* wait for 2, ..., 4 weeks to see whether there are bug reports that can be
  fixed in a 0.22.4 "micro release".

* Release 0.22.4 (which already contains some smaller fixes as well as
  announcements of upcoming changes, see HISTORY and RELEASE-NOTES).

* There are some new features in patches and local branches that could
  result in a 0.23 version soon after that.

* If possible, do the conversion of our repository from SVN to Git.
  
* Then prepare for Docutils 1.0.


Feedback and ideas are much appreciated.

    
Have a nice "Adventszeit"

Günter    

[Docutils-develop] [docutils:bugs] #515 Wrong statement in "reStructuredText Specification"

[Günter M. <mi...@us...>]

Proposed patch:
~~~diff
-- 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 alignment to the top of the section


Attachments:

- [0001-Fix-statement-in-rST-Specification-example.patch](https://sourceforge.net/p/docutils/bugs/_discuss/thread/a50f8b8dab/f886/attachment/0001-Fix-statement-in-rST-Specification-example.patch) (5.1 kB; text/x-patch)


---

**[bugs:#515] Wrong statement in "reStructuredText Specification"**

**Status:** open
**Labels:** Documentation 
**Created:** Tue Dec 02, 2025 10:45 AM UTC by Günter Milde
**Last Updated:** Tue Dec 02, 2025 10:45 AM UTC
**Owner:** nobody


The rST specification states in one example that
"A footnote contains body elements, consistently indented by at least 3 spaces."
The minimal indentation in rST is one space.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #515 Wrong statement in "reStructuredText Specification"

[Günter M. <mi...@us...>]

---

**[bugs:#515] Wrong statement in "reStructuredText Specification"**

**Status:** open
**Labels:** Documentation 
**Created:** Tue Dec 02, 2025 10:45 AM UTC by Günter Milde
**Last Updated:** Tue Dec 02, 2025 10:45 AM UTC
**Owner:** nobody


The rST specification states in one example that
"A footnote contains body elements, consistently indented by at least 3 spaces."
The minimal indentation in rST is one space.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #514 publish_file no longer works with "BytesIO-like" objects.

[Günter M. <mi...@us...>]

- **summary**: publish_file no longer works / crashes --> publish_file no longer works with "BytesIO-like" objects.
- **status**: open --> open-fixed



---

**[bugs:#514] publish_file no longer works with "BytesIO-like" objects.**

**Status:** open-fixed
**Created:** Sat Nov 15, 2025 05:26 PM UTC by Kristian Lehto
**Last Updated:** Mon Dec 01, 2025 10:44 PM UTC
**Owner:** nobody


Hello,

We are using code bellow to convert rst files to html.

Code works fine if we use old docutils version 0.20.1.

python -m pip install docutils==0.20.1

But current 0.22.3 version crashes.

import io
from docutils.core import publish_file

text = open('test.rst', 'rb').read()
source = io.BytesIO(text)
destination = open('test.html', 'w')
publish_file(source=source, destination=destination, writer_name='html')
destination.close()
source.close()

Traceback (most recent call last):
  File "C:\projects\test\test.py", line 7, in <module>
    publish_file(source=source, destination=destination, writer_name='html')
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 465, in publish_file
    output, _publisher = publish_programmatically(
                         ~~~~~~~~~~~~~~~~~~~~~~~~^
        source_class=io.FileInput, source=source, source_path=source_path,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<7 lines>...
        config_section=config_section,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        enable_exit_status=enable_exit_status)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 794, in publish_programmatically
    output = publisher.publish(enable_exit_status=enable_exit_status)
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 269, in publish
    self.document = self.reader.read(self.source, self.parser,
                    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
                                     self.settings)
                                     ^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\readers\__init__.py", line 95, in read
    self.parse()
    ~~~~~~~~~~^^
  File "C:\Python314\Lib\site-packages\docutils\readers\__init__.py", line 101, in parse
    self.parser.parse(self.input, document)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\parsers\rst\__init__.py", line 175, in parse
    inputlines = docutils.statemachine.string2lines(
          inputstring, tab_width=document.settings.tab_width,
          convert_whitespace=True)
  File "C:\Python314\Lib\site-packages\docutils\statemachine.py", line 1515, in string2lines
    astring = whitespace.sub(' ', astring)
TypeError: cannot use a string pattern on a bytes-like object


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #514 publish_file no longer works / crashes

[Günter M. <mi...@us...>]

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


---

**[bugs:#514] publish_file no longer works / crashes**

**Status:** open
**Created:** Sat Nov 15, 2025 05:26 PM UTC by Kristian Lehto
**Last Updated:** Sun Nov 16, 2025 04:58 AM UTC
**Owner:** nobody


Hello,

We are using code bellow to convert rst files to html.

Code works fine if we use old docutils version 0.20.1.

python -m pip install docutils==0.20.1

But current 0.22.3 version crashes.

import io
from docutils.core import publish_file

text = open('test.rst', 'rb').read()
source = io.BytesIO(text)
destination = open('test.html', 'w')
publish_file(source=source, destination=destination, writer_name='html')
destination.close()
source.close()

Traceback (most recent call last):
  File "C:\projects\test\test.py", line 7, in <module>
    publish_file(source=source, destination=destination, writer_name='html')
    ~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 465, in publish_file
    output, _publisher = publish_programmatically(
                         ~~~~~~~~~~~~~~~~~~~~~~~~^
        source_class=io.FileInput, source=source, source_path=source_path,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<7 lines>...
        config_section=config_section,
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        enable_exit_status=enable_exit_status)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 794, in publish_programmatically
    output = publisher.publish(enable_exit_status=enable_exit_status)
  File "C:\Python314\Lib\site-packages\docutils\core.py", line 269, in publish
    self.document = self.reader.read(self.source, self.parser,
                    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
                                     self.settings)
                                     ^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\readers\__init__.py", line 95, in read
    self.parse()
    ~~~~~~~~~~^^
  File "C:\Python314\Lib\site-packages\docutils\readers\__init__.py", line 101, in parse
    self.parser.parse(self.input, document)
    ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Python314\Lib\site-packages\docutils\parsers\rst\__init__.py", line 175, in parse
    inputlines = docutils.statemachine.string2lines(
          inputstring, tab_width=document.settings.tab_width,
          convert_whitespace=True)
  File "C:\Python314\Lib\site-packages\docutils\statemachine.py", line 1515, in string2lines
    astring = whitespace.sub(' ', astring)
TypeError: cannot use a string pattern on a bytes-like object


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #128 combining unicode chars count in grid tables

[Günter M. <mi...@us...>]

- **status**: open-fixed --> closed-fixed
- **Comment**:

Fixed in Docutils 0.22.3.



---

**[bugs:#128] combining unicode chars count in grid tables**

**Status:** closed-fixed
**Created:** Tue Jan 05, 2010 10:49 AM UTC by Günter Milde
**Last Updated:** Mon Sep 22, 2025 09:44 PM UTC
**Owner:** nobody


Combining unicode chars in <s>headings and simple</s> grid tables lead to warnings and errors, as they contribute to the string lenght.




---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #512 rst2html incorrectly converts tables with Combining Diacritical Marks into HTML

[Günter M. <mi...@us...>]

- **status**: open-fixed --> closed-fixed
- **Comment**:

Fixed in Docutils 0.22.3.



---

**[bugs:#512] rst2html incorrectly converts tables with Combining Diacritical Marks into HTML**

**Status:** closed-fixed
**Labels:** rst parser 
**Created:** Tue Sep 16, 2025 07:28 PM UTC by CHÉN Zhé
**Last Updated:** Mon Sep 22, 2025 09:45 PM UTC
**Owner:** nobody
**Attachments:**

- [expected.png](https://sourceforge.net/p/docutils/bugs/512/attachment/expected.png) (682 Bytes; image/png)
- [result.png](https://sourceforge.net/p/docutils/bugs/512/attachment/result.png) (702 Bytes; image/png)
- [test.rst](https://sourceforge.net/p/docutils/bugs/512/attachment/test.rst) (23 Bytes; application/octet-stream)


Content of reST file:

~~~
+----+
| ç̌ |
+----+
~~~

Expected results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌</td>
    </tr>
  </tbody>
</table>
~~~

Real results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌ |</td>
    </tr>
  </tbody>
</table>
~~~


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] docutils 0.22.3 released

[engelbert g. <eng...@gm...>]

Hei everyone,

on very short notice a very small release
Quick tiny release for two important bugfixes.

1. The longstanding issue with combining characters in grid tables is finally
  solved.

2. A fix for a problem for Sphinx users with Docutils 0.22.2 is solved as well.

cheers and all the best
 e

[Docutils-develop] Release Docutils 0.22.3?

[Guenter M. <mi...@us...>]

Dear Docutils developers, dear Engelbert,

IMO, two important bugfixes in the development version merit a new
minor release:

* The longstanding issue with combining characters in grid tables is finally
  solved.
  
* A fix for a problem for Sphinx users with Docutils 0.22.2 is solved as well.

@Engelbert: Could you prepare/release Docutils 0.22.3?


Günter

[Docutils-develop] [docutils:patches] #215 Fix Unknown target name warning in roles.rst

[Günter M. <mi...@us...>]

- **status**: open --> open-fixed
- **Comment**:

Fixed in [r10249] (with different wording).
Thanks for finding the broken link and the patch.



---

**[patches:#215] Fix Unknown target name warning in roles.rst**

**Status:** open-fixed
**Group:** None
**Created:** Fri Sep 19, 2025 07:13 PM UTC by Dmitry Shachnev
**Last Updated:** Fri Sep 19, 2025 07:13 PM UTC
**Owner:** nobody
**Attachments:**

- [0001-Fix-Unknown-target-name-warning-in-roles.rst.patch](https://sourceforge.net/p/docutils/patches/215/attachment/0001-Fix-Unknown-target-name-warning-in-roles.rst.patch) (918 Bytes; text/x-patch)


This fixes a minor problem that I noticed when building a Debian package for 0.22.1.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #512 rst2html incorrectly converts tables with Combining Diacritical Marks into HTML

[Günter M. <mi...@us...>]

- **status**: open --> open-fixed



---

**[bugs:#512] rst2html incorrectly converts tables with Combining Diacritical Marks into HTML**

**Status:** open-fixed
**Labels:** rst parser 
**Created:** Tue Sep 16, 2025 07:28 PM UTC by CHÉN Zhé
**Last Updated:** Mon Sep 22, 2025 09:44 PM UTC
**Owner:** nobody
**Attachments:**

- [expected.png](https://sourceforge.net/p/docutils/bugs/512/attachment/expected.png) (682 Bytes; image/png)
- [result.png](https://sourceforge.net/p/docutils/bugs/512/attachment/result.png) (702 Bytes; image/png)
- [test.rst](https://sourceforge.net/p/docutils/bugs/512/attachment/test.rst) (23 Bytes; application/octet-stream)


Content of reST file:

~~~
+----+
| ç̌ |
+----+
~~~

Expected results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌</td>
    </tr>
  </tbody>
</table>
~~~

Real results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌ |</td>
    </tr>
  </tbody>
</table>
~~~


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #512 rst2html incorrectly converts tables with Combining Diacritical Marks into HTML

[Günter M. <mi...@us...>]

Fixed in [r10251].


---

**[bugs:#512] rst2html incorrectly converts tables with Combining Diacritical Marks into HTML**

**Status:** open
**Labels:** rst parser 
**Created:** Tue Sep 16, 2025 07:28 PM UTC by CHÉN Zhé
**Last Updated:** Fri Sep 19, 2025 12:40 PM UTC
**Owner:** nobody
**Attachments:**

- [expected.png](https://sourceforge.net/p/docutils/bugs/512/attachment/expected.png) (682 Bytes; image/png)
- [result.png](https://sourceforge.net/p/docutils/bugs/512/attachment/result.png) (702 Bytes; image/png)
- [test.rst](https://sourceforge.net/p/docutils/bugs/512/attachment/test.rst) (23 Bytes; application/octet-stream)


Content of reST file:

~~~
+----+
| ç̌ |
+----+
~~~

Expected results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌</td>
    </tr>
  </tbody>
</table>
~~~

Real results:

~~~
<table border="1" class="docutils">
  <colgroup>
    <col width="100%" />
  </colgroup>
  <tbody valign="top">
    <tr><td>ç̌ |</td>
    </tr>
  </tbody>
</table>
~~~


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #128 combining unicode chars count in grid tables

[Günter M. <mi...@us...>]

- **status**: open --> open-fixed
- **Comment**:

Fixed, now also for grid tables, in [r10251].



---

**[bugs:#128] combining unicode chars count in grid tables**

**Status:** open-fixed
**Created:** Tue Jan 05, 2010 10:49 AM UTC by Günter Milde
**Last Updated:** Wed Sep 17, 2025 03:01 PM UTC
**Owner:** nobody


Combining unicode chars in <s>headings and simple</s> grid tables lead to warnings and errors, as they contribute to the string lenght.




---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #513 error installing v0.22.1 on MacOS

[Günter M. <mi...@us...>]

- **status**: open --> closed-fixed
- **Comment**:

Fixed with release 0.22.2.
Thank you for report, analysis, and testing.



---

**[bugs:#513] error installing v0.22.1 on MacOS**

**Status:** closed-fixed
**Created:** Thu Sep 18, 2025 11:58 AM UTC by Daeho Ro
**Last Updated:** Sun Sep 21, 2025 06:28 AM UTC
**Owner:** nobody


Hello, when I install `docutil` v0.22.1, I got an error

```
  docutils-0.22.1/docutils/__init__.py: Failed to restore metadata: File exists
  tar: Error exit delayed from previous errors.
  Error: Failure while executing; `/usr/bin/env tar --extract --no-same-owner --file /Users/brew/Library/Caches/Homebrew/downloads/88b03c744685105eccb97d4a6655d840b7fed55a81342d1432838845ab291c6f--docutils-0.22.1.tar.gz --directory /private/tmp/homebrew-unpack-20250917-6599-dbea5b` exited with 1. Here's the output:
```

Some other package depending on this also occur same error.
Can you check?

Thanks,


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #513 error installing v0.22.1 on MacOS

[Günter M. <mi...@us...>]

Docutils 0.22.2 is out (without the `*.swp` file).
@daeho-ro: Could you please try whether this solves the install problem?


---

**[bugs:#513] error installing v0.22.1 on MacOS**

**Status:** open
**Created:** Thu Sep 18, 2025 11:58 AM UTC by Daeho Ro
**Last Updated:** Sat Sep 20, 2025 08:50 AM UTC
**Owner:** nobody


Hello, when I install `docutil` v0.22.1, I got an error

```
  docutils-0.22.1/docutils/__init__.py: Failed to restore metadata: File exists
  tar: Error exit delayed from previous errors.
  Error: Failure while executing; `/usr/bin/env tar --extract --no-same-owner --file /Users/brew/Library/Caches/Homebrew/downloads/88b03c744685105eccb97d4a6655d840b7fed55a81342d1432838845ab291c6f--docutils-0.22.1.tar.gz --directory /private/tmp/homebrew-unpack-20250917-6599-dbea5b` exited with 1. Here's the output:
```

Some other package depending on this also occur same error.
Can you check?

Thanks,


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] release docutils 0.22.2

[engelbert g. <eng...@gm...>]

sorry for the high frequency

0.22.2 is a fix release for 0.22.1
minus one editor swap file that somehow broke a MacOS homebrew installation

otherwise nothing changed

sorry for any inconvenience
 e

[Docutils-develop] [docutils:bugs] #513 error installing v0.22.1 on MacOS

[Günter M. <mi...@us...>]

- **summary**: error on v0.22.1 --> error installing v0.22.1 on MacOS
- **Comment**:

It seems that install on  MacOS (or just homebrew or snakemake, ...) trip over the spurious file while with Python's standard "pip" installment program or installing "by hand" the spurious file is just ignored.
We will release a new version without the spurious file ASAP.



---

**[bugs:#513] error installing v0.22.1 on MacOS**

**Status:** open
**Created:** Thu Sep 18, 2025 11:58 AM UTC by Daeho Ro
**Last Updated:** Sat Sep 20, 2025 03:54 AM UTC
**Owner:** nobody


Hello, when I install `docutil` v0.22.1, I got an error

```
  docutils-0.22.1/docutils/__init__.py: Failed to restore metadata: File exists
  tar: Error exit delayed from previous errors.
  Error: Failure while executing; `/usr/bin/env tar --extract --no-same-owner --file /Users/brew/Library/Caches/Homebrew/downloads/88b03c744685105eccb97d4a6655d840b7fed55a81342d1432838845ab291c6f--docutils-0.22.1.tar.gz --directory /private/tmp/homebrew-unpack-20250917-6599-dbea5b` exited with 1. Here's the output:
```

Some other package depending on this also occur same error.
Can you check?

Thanks,


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #513 error on v0.22.1

[Günter M. <mi...@us...>]

I cannot reproduce the install problem here. Installing Docutils 0.22.1 with pip into a
new created venv worked without problem, despite the spurious file.

What is the OS?
Which command was used for the install? 
If you used pip,  run it with increased verbosity and share the details:

    pip install <package-name> --verbose

You may consider removing the spurious file 

    /docutils-0.22.1/docutils/.__init__.py.swp

from the wheel or tar.gz archive (or manually unpacking and then removing) and trying again.


---

**[bugs:#513] error on v0.22.1**

**Status:** open
**Created:** Thu Sep 18, 2025 11:58 AM UTC by Daeho Ro
**Last Updated:** Fri Sep 19, 2025 12:36 PM UTC
**Owner:** nobody


Hello, when I install `docutil` v0.22.1, I got an error

```
  docutils-0.22.1/docutils/__init__.py: Failed to restore metadata: File exists
  tar: Error exit delayed from previous errors.
  Error: Failure while executing; `/usr/bin/env tar --extract --no-same-owner --file /Users/brew/Library/Caches/Homebrew/downloads/88b03c744685105eccb97d4a6655d840b7fed55a81342d1432838845ab291c6f--docutils-0.22.1.tar.gz --directory /private/tmp/homebrew-unpack-20250917-6599-dbea5b` exited with 1. Here's the output:
```

Some other package depending on this also occur same error.
Can you check?

Thanks,


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:patches] #214 Give better messages on malformed tables

[Günter M. <mi...@us...>]

- **status**: open-fixed --> closed-fixed
- **Comment**:

Fixed in Docutils 0.22.1. Thanks again.



---

**[patches:#214] Give better messages on malformed tables**

**Status:** closed-fixed
**Group:** None
**Created:** Sun Jun 08, 2025 05:58 PM UTC by Jynn Nelson
**Last Updated:** Tue Aug 19, 2025 09:30 PM UTC
**Owner:** nobody
**Attachments:**

- [tables.diff](https://sourceforge.net/p/docutils/patches/214/attachment/tables.diff) (5.2 kB; application/octet-stream)


This does several things:
- Specifies `Misaligned right border` for that error, instead of just "malformed table".
- Shows the line where each error happened, not the line where the table starts.
  - This had a complication that line numbers appear to be wrong when `include` directives are present (they include the lines in the source document, instead of being relative to the included document). Just disabled the new smarter logic in that case.
- Changes `malformed_table` to require both detail and an offset, so poor errors like this can't happen in the future.

Fixes https://sourceforge.net/p/docutils/bugs/504/.


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #493 Test failure on Windows with embedded images

[Günter M. <mi...@us...>]

- **status**: open-fixed --> closed-fixed



---

**[bugs:#493] Test failure on Windows with embedded images**

**Status:** closed-fixed
**Created:** Wed Aug 07, 2024 02:25 AM UTC by Adam  Turner
**Last Updated:** Wed Jul 30, 2025 09:11 AM UTC
**Owner:** nobody


xref [r9785], [r9853], [r9855]

Dear @milde,

Thank you for the fix to my recent patch. It seems neither my patch nor the fix addressed the root cause of the test failures, as tests have resumed failing on Windows.

I believe the following demonstrates the problem:

```pycon
>>> import sys; print(sys.platform)
win32
>>> import urllib.parse, urllib.request
>>> urllib.request.url2pathname('test/data/circle-broken.svg')
'test\\data\\circle-broken.svg'
>>> urllib.parse.unquote('test/data/circle-broken.svg')
'test/data/circle-broken.svg'
```

Currently, we use `imagepath = urllib.request.url2pathname(uri_parts.path)`, which converts path separators to their platform-native format. On UNIX, `url2pathname` simply calls `unquote`, but on Windows it handles UNC paths (``\\host\path\``) and escaped drive letters (``///C|/users/``).

I don't know what led to using `url2pathname()`, as it is quite specialised (the docstring notes "not recommended for general use"). Is it possible to use the simpler `unquote()` here?  

For local file paths (e.g. without a ``file:///`` scheme), should we even be using URI parsing? Perhaps we should use proper path handling if there is no URI scheme (i.e. the user has provided a file-path).

A


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #503 LaTeX writer fails to generate "labels" for some elements with "ids".

[Günter M. <mi...@us...>]

- **status**: open-fixed --> closed-fixed



---

**[bugs:#503] LaTeX writer fails to generate "labels" for some elements with "ids".**

**Status:** closed-fixed
**Created:** Wed Jun 04, 2025 04:34 PM UTC by Günter Milde
**Last Updated:** Thu Sep 18, 2025 07:43 AM UTC
**Owner:** nobody


Most doctree elements (nodes) accept the "ids" attribute that can be used as end-point for internal cross references.
In LaTeX, "ids" are represented as "labels". This is only implemented for a small subset of elements.
For example the internal hyperlink in 
~~~
.. note::
   :name: my-note
   
   This is an admonition with ID
   
Link to my-note_. 
~~~
does not work because there is no `\label{my-note}`  in the LaTeX output.

See also [Sphinx issue #13609](https://github.com/sphinx-doc/sphinx/issues/13609#issuecomment-2937289148).


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.

[Docutils-develop] [docutils:bugs] #503 LaTeX writer fails to generate "labels" for some elements with "ids".

[Günter M. <mi...@us...>]

- **Comment**:

Fixed in [Docutils 0.22.1](https://pypi.org/project/docutils/0.22.1/).



---

**[bugs:#503] LaTeX writer fails to generate "labels" for some elements with "ids".**

**Status:** open-fixed
**Created:** Wed Jun 04, 2025 04:34 PM UTC by Günter Milde
**Last Updated:** Thu Aug 21, 2025 04:24 PM UTC
**Owner:** nobody


Most doctree elements (nodes) accept the "ids" attribute that can be used as end-point for internal cross references.
In LaTeX, "ids" are represented as "labels". This is only implemented for a small subset of elements.
For example the internal hyperlink in 
~~~
.. note::
   :name: my-note
   
   This is an admonition with ID
   
Link to my-note_. 
~~~
does not work because there is no `\label{my-note}`  in the LaTeX output.

See also [Sphinx issue #13609](https://github.com/sphinx-doc/sphinx/issues/13609#issuecomment-2937289148).


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.