docutils-develop — For developer discussions of the implementation.

[Docutils-develop] myst-docutils 0.16.0 available

[<jua...@re...>]

Hi all,


Chris Sewell from the Executable Books Project has released myst-docutils, an extended CommonMark-compliant parser that can be used in docutils instead of the deprecated recommonmark. myst-docutils does not depend on Sphinx so it shouldn't present any circular dependency problems.


Background: https://github.com/executablebooks/MyST-Parser/issues/347


Looking forward to seeing better Markdown support in docutils, which I suppose could enable Sphinx to read it without additional extensions?

Cheers,
ju...@re...
Read the Docs

Re: [Docutils-develop] myst-docutils 0.16.0 available

[chris s. <chr...@ho...>]

Yep thanks Juan,

See also https://myst-parser.readthedocs.io/en/latest/docutils.html, for specifics about using myst-parser with docutils, and also the new command line tools!

Kind Regards,
Chris

On 15 Dec 2021, at 16:31, Juan Luis Cano Rodríguez <jua...@re...> wrote:


Hi all,

Chris Sewell from the Executable Books Project has released myst-docutils, an extended CommonMark-compliant parser that can be used in docutils instead of the deprecated recommonmark. myst-docutils does not depend on Sphinx so it shouldn't present any circular dependency problems.

Background: https://github.com/executablebooks/MyST-Parser/issues/347

Looking forward to seeing better Markdown support in docutils, which I suppose could enable Sphinx to read it without additional extensions?

Cheers,
ju...@re...
Read the Docs
[Sent from Front]

[Docutils-develop] [docutils:bugs] Re: #439 Field names in field lists have max length of 14 characters

[Álvaro M. R. <mo...@us...>]

Great, thank you!


---

** [bugs:#439] Field names in field lists have max length of 14 characters**

**Status:** closed-invalid
**Created:** Fri Dec 10, 2021 09:11 PM UTC by Álvaro Mondéjar Rubio
**Last Updated:** Sat Dec 11, 2021 09:47 PM UTC
**Owner:** nobody


Hi,

I'm debugging an strange behaviour of docutils 0.18.1 with Python 3.8.10.

Minimal reproducible example:

~~~python
from docutils.core import publish_parts
from docutils.writers.html4css1 import Writer

content = """Some text

:012345678901234: foo
:a: b
:0123456789012345: bar
:01234567890123: baz
"""

print(publish_parts(content, writer=Writer())["fragment"])
~~~

Output:

~~~html
<p>Some text</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name" colspan="2">012345678901234:</th></tr>
<tr class="field"><td> </td><td class="field-body">foo</td>
</tr>
<tr class="field"><th class="field-name">a:</th><td class="field-body">b</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">0123456789012345:</th></tr>
<tr class="field"><td> </td><td class="field-body">bar</td>
</tr>
<tr class="field"><th class="field-name">01234567890123:</th><td class="field-body">baz</td>
</tr>
</tbody>
</table>
~~~

It seems that doesn't accept field names larger than 14 characters, adding additionals rows in the table with HTML escaped ` ` spaces. Checking the documentation about [field lists](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists) I can't find anything related, nor in the [RFC822](https://www.rfc-editor.org/rfc/rfc822.txt).

Is this an expected behaviour? 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] #438 The source info of topic node is not filled when topic directive only contains a bullet list

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

This is one more instance of feature request [#41].
Is there a use case for the internal source and line attributes for topic nodes?

The interesting point is that in some cases there is a "source" attribute (but no "line" attribute) for the "topic" node. (Tested with `rst2pseudoxml --expose-internal-attributes=source:line`.)



---

** [bugs:#438] The source info of topic node is not filled when topic directive only contains a bullet list**

**Status:** open
**Created:** Thu Dec 09, 2021 04:37 PM UTC by Takeshi KOMIYA
**Last Updated:** Thu Dec 09, 2021 04:37 PM UTC
**Owner:** nobody


It seems docutils does not fill the topic node with the source info when the topic directive has a bullet list.

```
from docutils.core import publish_doctree


# topic directive with a paragraph
s = """
.. topic:: 5. Topic Title

   Paragraph
"""

(topic,) = publish_doctree(s)
print(topic.source, topic.line)


# topic directive with a bullet list
s = """
.. topic:: 5. Topic Title

   - Bullet List Item
"""

(topic,) = publish_doctree(s)
print(topic.source, topic.line)
```
```
$ python test.py
<string> None
None None
```


---

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] #439 Field names in field lists have max length of 14 characters

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

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

There is no limit to the length of field names (check the output of the "pseudoxml" or "docutils XML" writers).
The observed behaviour is a rendering feature of the "html4css1" writer, described in the [Docutils Configuration ](https://docutils.sourceforge.io/docs/user/config.html#field-name-limit) guide. You can configure the field-name limit or consider switching to the [html5 writer ](https://docutils.sourceforge.io/docs/user/html.html#html5-polyglot) that converts field lists to HTML description lists with the "field-list" class.



---

** [bugs:#439] Field names in field lists have max length of 14 characters**

**Status:** closed-invalid
**Created:** Fri Dec 10, 2021 09:11 PM UTC by Álvaro Mondéjar Rubio
**Last Updated:** Fri Dec 10, 2021 09:11 PM UTC
**Owner:** nobody


Hi,

I'm debugging an strange behaviour of docutils 0.18.1 with Python 3.8.10.

Minimal reproducible example:

~~~python
from docutils.core import publish_parts
from docutils.writers.html4css1 import Writer

content = """Some text

:012345678901234: foo
:a: b
:0123456789012345: bar
:01234567890123: baz
"""

print(publish_parts(content, writer=Writer())["fragment"])
~~~

Output:

~~~html
<p>Some text</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name" colspan="2">012345678901234:</th></tr>
<tr class="field"><td> </td><td class="field-body">foo</td>
</tr>
<tr class="field"><th class="field-name">a:</th><td class="field-body">b</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">0123456789012345:</th></tr>
<tr class="field"><td> </td><td class="field-body">bar</td>
</tr>
<tr class="field"><th class="field-name">01234567890123:</th><td class="field-body">baz</td>
</tr>
</tbody>
</table>
~~~

It seems that doesn't accept field names larger than 14 characters, adding additionals rows in the table with HTML escaped ` ` spaces. Checking the documentation about [field lists](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists) I can't find anything related, nor in the [RFC822](https://www.rfc-editor.org/rfc/rfc822.txt).

Is this an expected behaviour? 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] #439 Field names in field lists have max length of 14 characters

[Álvaro M. R. <mo...@us...>]

---

** [bugs:#439] Field names in field lists have max length of 14 characters**

**Status:** open
**Created:** Fri Dec 10, 2021 09:11 PM UTC by Álvaro Mondéjar Rubio
**Last Updated:** Fri Dec 10, 2021 09:11 PM UTC
**Owner:** nobody


Hi,

I'm debugging an strange behaviour of docutils 0.18.1 with Python 3.8.10.

Minimal reproducible example:

~~~python
from docutils.core import publish_parts
from docutils.writers.html4css1 import Writer

content = """Some text

:012345678901234: foo
:a: b
:0123456789012345: bar
:01234567890123: baz
"""

print(publish_parts(content, writer=Writer())["fragment"])
~~~

Output:

~~~html
<p>Some text</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name" colspan="2">012345678901234:</th></tr>
<tr class="field"><td> </td><td class="field-body">foo</td>
</tr>
<tr class="field"><th class="field-name">a:</th><td class="field-body">b</td>
</tr>
<tr class="field"><th class="field-name" colspan="2">0123456789012345:</th></tr>
<tr class="field"><td> </td><td class="field-body">bar</td>
</tr>
<tr class="field"><th class="field-name">01234567890123:</th><td class="field-body">baz</td>
</tr>
</tbody>
</table>
~~~

It seems that doesn't accept field names larger than 14 characters, adding additionals rows in the table with HTML escaped ` ` spaces. Checking the documentation about [field lists](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#field-lists) I can't find anything related, nor in the [RFC822](https://www.rfc-editor.org/rfc/rfc822.txt).

Is this an expected behaviour? 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] #438 The source info of topic node is not filled when topic directive only contains a bullet list

[Takeshi K. <tk...@us...>]

---

** [bugs:#438] The source info of topic node is not filled when topic directive only contains a bullet list**

**Status:** open
**Created:** Thu Dec 09, 2021 04:37 PM UTC by Takeshi KOMIYA
**Last Updated:** Thu Dec 09, 2021 04:37 PM UTC
**Owner:** nobody


It seems docutils does not fill the topic node with the source info when the topic directive has a bullet list.

```
from docutils.core import publish_doctree


# topic directive with a paragraph
s = """
.. topic:: 5. Topic Title

   Paragraph
"""

(topic,) = publish_doctree(s)
print(topic.source, topic.line)


# topic directive with a bullet list
s = """
.. topic:: 5. Topic Title

   - Bullet List Item
"""

(topic,) = publish_doctree(s)
print(topic.source, topic.line)
```
```
$ python test.py
<string> None
None None
```


---

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] #435 invalid references in "problematic" nodes with report_level=4

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

- **summary**: HTML writer generates invalid references with report_level=4 --> invalid references in "problematic" nodes with report_level=4
- **Comment**:

Edit heading: The problem is already in the document tree: with `report_level: 4` the FilterMessages transform removes SystemMessages but leaves "problematic" nodes  untouched.
We need to define the intended behaviour for error messages generated during the parsing of inline elements:
a) silently drop the faulty inline element,
b) insert rawsource
c) insert "problematic" node but don't link.






---

** [bugs:#435] invalid references in "problematic" nodes with report_level=4**

**Status:** open
**Created:** Tue Nov 16, 2021 04:50 PM UTC by Dmitry Shachnev
**Last Updated:** Wed Nov 17, 2021 07:10 PM UTC
**Owner:** nobody


I don’t know if you will consider it a bug, but I decided to report it nevertheless.

When input reStructuredText has errors and you silence them with report_level=4, the following HTML will be generated:
```python
>>> from docutils.core import publish_parts
>>> parts = publish_parts('`', settings_overrides={'report_level': 4}, writer_name='html5')
>>> print(parts['html_body'])
<main>
<p><a href="#system-message-1"><span class="problematic" id="problematic-1">`</span></a></p>
</main>
```

The link is pointing to `#system-message-1`, however there is no element with `id="system-message-id"` because the warning itself was not generated.


---

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] #437 Text.rawsource incorrectly removed (or falsely advertised) in 0.18

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

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



---

** [bugs:#437] Text.rawsource incorrectly removed (or falsely advertised) in 0.18**

**Status:** open-fixed
**Created:** Mon Nov 29, 2021 05:37 PM UTC by Rodrigo Tobar
**Last Updated:** Thu Dec 02, 2021 12:41 AM UTC
**Owner:** nobody


The attribute `Text.rawsource` has been removed already in version 0.18, but the [release notes](https://docutils.sourceforge.io/RELEASE-NOTES.html) show this as a "future change". What is the correct stance?

This is currently affecting [pospell](https://github.com/AFPy/pospell/issues/30), which has pinned its dependency on docutils to `docutils>=0.11,<0.18`.


---

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] #437 Text.rawsource incorrectly removed (or falsely advertised) in 0.18

[Rodrigo T. <rt...@us...>]

Thanks for fixing the release notes and for the clarification.

At the end we ended up raising the lowest required version to 0.16, so went for the `unescape` method.


---

** [bugs:#437] Text.rawsource incorrectly removed (or falsely advertised) in 0.18**

**Status:** open
**Created:** Mon Nov 29, 2021 05:37 PM UTC by Rodrigo Tobar
**Last Updated:** Wed Dec 01, 2021 04:46 PM UTC
**Owner:** nobody


The attribute `Text.rawsource` has been removed already in version 0.18, but the [release notes](https://docutils.sourceforge.io/RELEASE-NOTES.html) show this as a "future change". What is the correct stance?

This is currently affecting [pospell](https://github.com/AFPy/pospell/issues/30), which has pinned its dependency on docutils to `docutils>=0.11,<0.18`.


---

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] #437 Text.rawsource incorrectly removed (or falsely advertised) in 0.18

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

I am sorry for the confusion and troubles.
Docutils 0.18 removed the attribute `nodes.Text.rawsource` but not (yet) the "rawsource" argument in  `nodes.Text`'s `__init__(self, data, rawsource=None)`.
[r8911] fixes the release notes.

The undocumented "rawsource" attribute of the classes defined in `nodes.py` is just a developer aid, not to be used in production.

Backwards-compatibility for <0.16 is possible with

    try:
           self.output.append(node.rawsource)
     except AttributeError
          self.output.append(docutils.nodes.unescape(node, restore_backslashes=True))

Thank you for reporting.


---

** [bugs:#437] Text.rawsource incorrectly removed (or falsely advertised) in 0.18**

**Status:** open
**Created:** Mon Nov 29, 2021 05:37 PM UTC by Rodrigo Tobar
**Last Updated:** Mon Nov 29, 2021 05:37 PM UTC
**Owner:** nobody


The attribute `Text.rawsource` has been removed already in version 0.18, but the [release notes](https://docutils.sourceforge.io/RELEASE-NOTES.html) show this as a "future change". What is the correct stance?

This is currently affecting [pospell](https://github.com/AFPy/pospell/issues/30), which has pinned its dependency on docutils to `docutils>=0.11,<0.18`.


---

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] #437 Text.rawsource incorrectly removed (or falsely advertised) in 0.18

[Rodrigo T. <rt...@us...>]

---

** [bugs:#437] Text.rawsource incorrectly removed (or falsely advertised) in 0.18**

**Status:** open
**Created:** Mon Nov 29, 2021 05:37 PM UTC by Rodrigo Tobar
**Last Updated:** Mon Nov 29, 2021 05:37 PM UTC
**Owner:** nobody


The attribute `Text.rawsource` has been removed already in version 0.18, but the [release notes](https://docutils.sourceforge.io/RELEASE-NOTES.html) show this as a "future change". What is the correct stance?

This is currently affecting [pospell](https://github.com/AFPy/pospell/issues/30), which has pinned its dependency on docutils to `docutils>=0.11,<0.18`.


---

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.

Re: [Docutils-develop] #436 docutils doesn't build with Python 3.11

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

On 2021-11-27, engelbert gruber via Docutils-develop wrote:

> made it pass in r8910

Thank you.

> maybe the file should be read with the correct encoding ?

Yes, of course (this is the test below the one with wrong encoding). 
The test with the wrong encoding is to check that Docutils does not write
a cryptic error.

> maybe we should not test the csv module anyway ?

We test the "csv-table" directive which happens to use the "csv" module.
Our tests are sometimes too specific and we need to adapt them for false
positives.

In this case, we also found a new problem:

  maybe breaking processing of the file would be better than producing
  garbled output
  
Unfortunately, there is no bulletproof method to know whether the encoding
is correct. Some files can be tested for BOM marks, sometime a heuristic
helps.

With CSV input, Docutils re-used (or worked around) an implementation
detail in the "csv" module (it used to fail on NULL bytes, so Docutils
emits a helpful error). With NULL support for "csv", it is IMO better to
handle all file inputs ("include", "csv", "raw") the same:

 * allow NULL bytes in the decoded strings
 * it is up to the user to ensure the proper encoding.

Günter

[Docutils-develop] [docutils:bugs] #436 docutils doesn't build with Python 3.11

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

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

Fixed in [r8910]



---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open-fixed
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Sat Nov 27, 2021 09:21 PM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] #436 docutils doesn't build with Python 3.11

[engelbert g. <gr...@us...>]

made it pass in r8910
maybe the file should be read with the correct encoding ?
maybe we should not test the csv module anyway ?


---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Sat Nov 27, 2021 11:11 AM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] Re: #436 docutils doesn't build with Python 3.11

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

Could you re-try with r8909?


---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Sat Nov 27, 2021 11:11 AM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] #436 docutils doesn't build with Python 3.11

[engelbert g. <gr...@us...>]

mine breaks ::
~~~

(du311) docutils$ python test/alltests.py 
Traceback (most recent call last):
  File "test/alltests.py", line 93, in <module>
    suite = suite()
            ^^^^^^^
  File "test/alltests.py", line 80, in suite
    suite = package_unittest.loadTestModules(DocutilsTestSupport.testroot,
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "test/package_unittest.py", line 102, in loadTestModules
    module = import_module(mod)
             ^^^^^^^^^^^^^^^^^^
  File "test/package_unittest.py", line 133, in import_module
    mod = __import__(name)
          ^^^^^^^^^^^^^^^^
  File "test/test_parsers/test_rst/test_directives/test_tables.py", line 67, in <module>
    null_bytes_exception = DocutilsTestSupport.exception_data(null_bytes)[0]
                           ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^
TypeError: 'NoneType' object is not subscriptable
~~~



---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Fri Nov 26, 2021 12:41 PM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] Re: #436 docutils doesn't build with Python 3.11

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

Thank you for the report.

> Docutils doesn't build because 3.11 adds support for null characters in
> the csv module, which breaks a test.

Could you attach a full test log?


---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Fri Nov 26, 2021 12:41 PM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] #436 docutils doesn't build with Python 3.11

[Tomáš H. <thr...@us...>]

The change was introduced in this commit: https://github.com/python/cpython/commit/b454e8e4df73bc73bc1a6f597431f171bfae8abd


---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Fri Nov 26, 2021 12:39 PM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] #436 docutils doesn't build with Python 3.11

[Tomáš H. <thr...@us...>]

---

** [bugs:#436] docutils doesn't build with Python 3.11**

**Status:** open
**Created:** Fri Nov 26, 2021 12:39 PM UTC by Tomáš Hrnčiar
**Last Updated:** Fri Nov 26, 2021 12:39 PM UTC
**Owner:** nobody


Hello,

in Fedora we started with rebuilding Python packages with preleases of Python 3.11, currently it is 2nd alpha. 

Docutils doesn't build because 3.11 adds support for null characters in the csv module, which breaks a test. See reproducer below.

>>> import csv
>>> from docutils.parsers.rst.directives import tables
>>> with open('utf-16.csv', 'rb') as f: csv_data = f.read()
... 
>>> csv_data = str(csv_data, 'latin1').splitlines()
>>> reader = csv.reader([tables.CSVTable.encode_for_csv(line + '\n') for line in csv_data])
>>> next(reader)

Python 3.11:

['þÿ\x00"\x00T\x00r\x00e\x00a\x00t\x00"\x00', '\x00 \x00"\x00Q\x00u\x00a\x00n\x00t\x00i\x00t\x00y\x00"\x00', '\x00 \x00"\x00D\x00e\x00s\x00c\x00r\x00i\x00p\x00t\x00i\x00o\x00n\x00"\x00']

Python 3.10:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
_csv.Error: line contains NUL



---

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] #431 docutils 0.18 - Error when using legacy Sphinx package

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

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

Fixed in Docutils 0.18.1.



---

** [bugs:#431] docutils 0.18 - Error when using legacy Sphinx package **

**Status:** closed-fixed
**Created:** Wed Oct 27, 2021 09:47 AM UTC by Lital Yair
**Last Updated:** Thu Nov 11, 2021 04:38 PM UTC
**Owner:** nobody


Hi All

We are using Sphinx version 3.1.2 and version 1.7.6 in 2 different services, and since today we have had errors when we try to build the documentation of those projects.

This is the error:
Exception occurred:
  File "/codebuild/output/src746283639/src/.python/lib/python3.8/site-packages/docutils/writers/html5_polyglot/__init__.py", line 445, in section_title_tags
    if (ids and self.settings.section_self_link
AttributeError: 'Values' object has no attribute 'section_self_link'

The issues are solved when we directly add the previous version of 'docutils' (0.17) to our docs requirements.

Any help will be much appreciated.
Thanks, Lital


---

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] #432 oblique not obligue

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

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

Fixed in Docutils 0.18.1.



---

** [bugs:#432] oblique not obligue**

**Status:** closed-fixed
**Created:** Fri Oct 29, 2021 09:44 PM UTC by Eric Hellman
**Last Updated:** Sun Oct 31, 2021 09:55 AM UTC
**Owner:** nobody


in 

docutils/writers/html5_polyglot/math.css line 315
commit a3dcc96410c6a7ea7d65237dd7405af96701b73e on github
v 0.18

~~~
font-style: obligue;  
~~~

should be 

`font-style: oblique;`



---

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] #434 Error when running the test suite for Docutils on Windows 10.

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

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

Fixed in 0.18.1. 
Thank you for the report and follow ups.



---

** [bugs:#434] Error when running the test suite for Docutils on Windows 10.**

**Status:** closed-fixed
**Labels:** test 
**Created:** Sun Nov 14, 2021 03:34 PM UTC by PotentialUser-54
**Last Updated:** Sun Nov 21, 2021 10:12 PM UTC
**Owner:** nobody


Running the test suite for Docutils on Windows 10 using [the instructions](https://docutils.sourceforge.io/README.html#running-the-test-suite) fails.

As instructed, I am now opening this bug report after checking that there is not already one.

```pwsh
PS <redacted>\docutils\docutils\test> python alltests.py
Traceback (most recent call last):
  File "<redacted>\docutils\docutils\test\alltests.py", line 93, in <module>
    suite = suite()
  File "<redacted>\docutils\docutils\test\alltests.py", line 80, in suite
    suite = package_unittest.loadTestModules(DocutilsTestSupport.testroot,
  File "<redacted>\docutils\docutils\test\package_unittest.py", line 102, in loadTestModules
    module = import_module(mod)
  File "<redacted>\docutils\docutils\test\package_unittest.py", line 133, in import_module
    mod = __import__(name)
  File "<redacted>\docutils\docutils\test\test_error_reporting.py", line 212, in <module>
    class SafeStringTests_locale(unittest.TestCase):
  File "<redacted>\docutils\docutils\test\test_error_reporting.py", line 225, in SafeStringTests_locale
    open(b'\xfc')
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xfc in position 0: invalid start byte
```

```pwsh
PS <redacted>\docutils\docutils\test> python ../tools/quicktest.py --version
quicktest.py (Docutils 0.18 [release])
PS <redacted>\docutils\docutils\test> python --version
Python 3.9.6
```


---

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 version 0.18.1 released

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

Contents

* nodes.Node.traverse() returns a list again to restore
  backwards compatibility (fixes bug #431).
and Small bugfixes (see HISTORY_).

Re: [Docutils-develop] Missing documentation

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

Dear Marko,

thanks for asking and thanks for the offer to help.

On 2021-11-19, Ristin Marko (rist) wrote:

> I noticed that the documentation for quite a few elements is missing
> at: https://docutils.sourceforge.io/docs/ref/doctree.html

Basic information for all elements is in
https://docutils.sourceforge.io/docs/ref/docutils.dtd.

> In particular, I need some insight on "reference" element. Could you
> give me some more information and then I'll try to form it in the docs
> and contribute back?

In docutils.dtd, I find "reference" in the categories:

<!ENTITY % body.elements
<!ENTITY % inline.elements

Allowed attributes and content:

<!-- Can also be a body element, when it contains an "image" element. -->
<!ELEMENT reference %text.model;>
<!ATTLIST reference
    name      CDATA     #IMPLIED
    %basic.atts;
    %reference.atts;
    %anonymous.att;>

The docutils.nodes.reference class is defined in docutils/nodes.py::

  class reference(General, Inline, Referential, TextElement): pass

This should solve "category", "parents", "children", "attributes", and
"parameter entities".


Hints for "analogues" should be in the writers: the visit_reference() and
depart_reference() functions transform <reference> nodes into the output
format.
The "_html_base" writer, e.g., converts <reference> nodes to <a> tags.

It may also be worth looking in the `DocBook Guide`__ for an analogue
element. In case of reference__, it turns out to be something completely
different (the one of the references in a book's References section).

__ https://tdg.docbook.org/tdg/5.1/
__ https://tdg.docbook.org/tdg/5.1/reference.html


For the "examples", convert a *minimal* example of `rST reference syntax`_
with rst2pseudoxml.py.

.. _rST reference syntax:
   https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-references


"Processing" depends on the output medium. It should allow the reader to
easily find (or navigate to) the referenced medium/point.

In Docutils, transforms/references.py contains the functions and classes to
handle the task of matching refernces to their targets.

....

I hope this will get you started. Please ask back whenever you are stuck in
the quest for a complete picture.

Günter