docutils-develop — For developer discussions of the implementation.

[Docutils-develop] [docutils:bugs] #441 Move from "optparse" to "argparse".

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

---

** [bugs:#441] Move from "optparse" to "argparse".**

**Status:** open
**Created:** Thu Jan 06, 2022 03:02 PM UTC by Günter Milde
**Last Updated:** Thu Jan 06, 2022 03:02 PM UTC
**Owner:** Günter Milde


The optparse documentation says:
> Deprecated since version 3.2: The optparse module is deprecated and will not be developed further; development will continue with the argparse module.

We are currently suppressing related deprecation warnings in the test suite.
After raising the Python dependency to >=3.7, now may be the right time to make the move.


---

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] Re: #188 Remove lingering references to Python 2

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

> Do you mean something like https://github.com/AA-Turner/docutils/compare/master...AA-Turner:remove-lingering-py2

Kind of. If only I could find a link/button to the raw patch on this page. 
Having to add ".patch" in the URL-field of my browser is possible but no good UI.


---

** [patches:#188] Remove lingering references to Python 2**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 08:30 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 01:57 PM UTC
**Owner:** nobody


@milde

The first commit removes textual references, the remaining do some clean-up in `nodes` and `error_reporting` -- I don't know if these are helpful. I think at least the first commit should be applied, though.

https://github.com/AA-Turner/docutils/pull/4 // https://github.com/AA-Turner/docutils/pull/4.patch


---

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:patches] #189 Remove 'prest'

[Adam T. <aa-...@us...>]

(I can't see @milde/Günter's response here, it may have gotten lost -- for context I was replying to him).


---

** [patches:#189] Remove 'prest'**

**Status:** open
**Group:** None
**Created:** Thu Jan 06, 2022 02:23 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 02:48 PM UTC
**Owner:** nobody


xref sourceforge.net/p/docutils/mailman/message/36748625 -- an earlier attempt.

It has now been 11 years (08/12/2010), and no changes. The code will remain in the souce control history should anyone want to revive it.

The first commit removes all the files under /prest and the second removes a final reference in the docs.

This code was quite confusing to me when I was first looking throuh the Docutils source tree - I hestitated to contribute for a while as I thought I might need to know Perl or need to translate any contributions. 

As a current contributor, when searching through the full codebase, there are spurious results from prest that are annoying -- not insurmountable, but a common annoyance, and I think dropping this would solve both issues of clarity (Docutils is purely a Python project) and developer experience.

A

https://github.com/AA-Turner/docutils/pull/5 // https://github.com/AA-Turner/docutils/pull/5.patch


---

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:patches] #189 Remove 'prest'

[Adam T. <aa-...@us...>]

> If it does not complicate this future separation, we may put "prest" to a rest now (maybe leaving prest/README).

I don't think it would, you'd just have one less repository.

> The plan here is, to split "prest" into a separate repository when moving to Git.

Ahh perfect, I didn't realise moving to Git had been agreed! Very happy to help out if you'd like.

If you wanted to keep 'prest' as you say it could just be split out into a different repository.

A



---

** [patches:#189] Remove 'prest'**

**Status:** open
**Group:** None
**Created:** Thu Jan 06, 2022 02:23 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 02:23 PM UTC
**Owner:** nobody


xref sourceforge.net/p/docutils/mailman/message/36748625 -- an earlier attempt.

It has now been 11 years (08/12/2010), and no changes. The code will remain in the souce control history should anyone want to revive it.

The first commit removes all the files under /prest and the second removes a final reference in the docs.

This code was quite confusing to me when I was first looking throuh the Docutils source tree - I hestitated to contribute for a while as I thought I might need to know Perl or need to translate any contributions. 

As a current contributor, when searching through the full codebase, there are spurious results from prest that are annoying -- not insurmountable, but a common annoyance, and I think dropping this would solve both issues of clarity (Docutils is purely a Python project) and developer experience.

A

https://github.com/AA-Turner/docutils/pull/5 // https://github.com/AA-Turner/docutils/pull/5.patch


---

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.

Re: [Docutils-develop] [docutils:patches] #189 Remove 'prest'

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

The plan here is, to split "prest" into a separate repository when moving to
Git.

If it does not complicate this future separation, we may put "prest" to a
rest now (maybe leaving prest/README).

[Docutils-develop] [docutils:patches] #187 Rename .txt files to .rst

[Adam T. <aa-...@us...>]

Perhaps if we don't hear from him in a month (early Februray) we could revisit this issue? (I was taught to try to be explicit rather than 'in the future' for reminders!)

A


---

** [patches:#187] Rename .txt files to .rst**

**Status:** pending-remind
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 02:33 PM UTC
**Owner:** David Goodger


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:patches] #187 Rename .txt files to .rst

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

- **status**: open --> pending-remind
- **assigned_to**: David Goodger
- **Comment**:

The "de facto" status is why I did not reject the proposal right away.
I am not against "endorsing" rst as extension for rST files.
However, I remember David Goodger beeing very clear about his preference in this question on several occasions. 
I don't think it is an urgent issue, so I prefer to let David decide.



---

** [patches:#187] Rename .txt files to .rst**

**Status:** pending-remind
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 01:16 PM UTC
**Owner:** David Goodger


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:patches] #189 Remove 'prest'

[Adam T. <aa-...@us...>]

---

** [patches:#189] Remove 'prest'**

**Status:** open
**Group:** None
**Created:** Thu Jan 06, 2022 02:23 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 02:23 PM UTC
**Owner:** nobody


xref sourceforge.net/p/docutils/mailman/message/36748625 -- an earlier attempt.

It has now been 11 years (08/12/2010), and no changes. The code will remain in the souce control history should anyone want to revive it.

The first commit removes all the files under /prest and the second removes a final reference in the docs.

This code was quite confusing to me when I was first looking throuh the Docutils source tree - I hestitated to contribute for a while as I thought I might need to know Perl or need to translate any contributions. 

As a current contributor, when searching through the full codebase, there are spurious results from prest that are annoying -- not insurmountable, but a common annoyance, and I think dropping this would solve both issues of clarity (Docutils is purely a Python project) and developer experience.

A

https://github.com/AA-Turner/docutils/pull/5 // https://github.com/AA-Turner/docutils/pull/5.patch


---

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:feature-requests] #86 Replace recommonmark with myst-docutils

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

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

Marking this as fixed, will close once the next release is out.

BTW: what is the state of https://pypi.org/project/pycmark/ by @ tk0miya?
It looks promising as a lightweight alternative for pure CommonMark
as it only depends on Docutils.

Thank you all for the good work.



---

** [feature-requests:#86] Replace recommonmark with myst-docutils**

**Status:** open-fixed
**Group:** Default
**Created:** Sun Jan 02, 2022 01:26 PM UTC by Chris Sewell
**Last Updated:** Wed Jan 05, 2022 05:58 PM UTC
**Owner:** nobody


Hey guys,

As discussed in https://github.com/readthedocs/recommonmark/issues/221, recommonmark has been officially deprecated in favour of https://github.com/executablebooks/MyST-Parser/.

In myst-parser v0.16, I added first-class support for direct docutils use (as opposed to via sphinx) and introduced the parallel https://pypi.org/project/myst-docutils/ distribution, which is myst-parser but without explicit install requirements on docutils or sphinx, i.e. you can install myst-docutils with any version of docutils and it will work without sphinx installed.

receive(see https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md#0160---2021-12-06, https://github.com/executablebooks/MyST-Parser/issues/347, and https://myst-parser.readthedocs.io/en/latest/docutils.html) 
receive
receiveIn the master branch (and soon to be myst-docutils v0.17) I have also been working to improve the rigour of the behaviour/testing against this parser.
(as an example, I believe your current recommonmark solution does not actually work properly with code fences, because it does not syntax highlight the code, see: https://github.com/executablebooks/MyST-Parser/pull/478)

The fixture test sets, essentially provide a full specification of the Markdown -> docutils AST conversion (pre-docutils-transforms):

- https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_syntax_elements.md
- https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_roles.md
-  https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_directives.md

and are currently tested in the CI for myst-docutils against docutils v0.16, v0.17 and v0.18: https://github.com/executablebooks/MyST-Parser/runs/4670995311?check_suite_focus=true

I'm also happy to recieve any feedback /  improvement suggestions to facilitate this, and have opened a parallel discussion topic here: https://github.com/executablebooks/MyST-Parser/discussions/487

Cheer,
Chris



---

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:patches] #188 Remove lingering references to Python 2

[Adam T. <aa-...@us...>]

Oops sorry didn't mean to send that yet!

> Do you want to have a look or may I just push?

I trust your judgement :P -- if there's anything I spot later on I can prepare a new patch.

A


---

** [patches:#188] Remove lingering references to Python 2**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 08:30 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 01:55 PM UTC
**Owner:** nobody


@milde

The first commit removes textual references, the remaining do some clean-up in `nodes` and `error_reporting` -- I don't know if these are helpful. I think at least the first commit should be applied, though.

https://github.com/AA-Turner/docutils/pull/4 // https://github.com/AA-Turner/docutils/pull/4.patch


---

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:patches] #188 Remove lingering references to Python 2

[Adam T. <aa-...@us...>]

> If Github would provide a "commitdiff" link 

Do you mean something like https://github.com/AA-Turner/docutils/compare/master...AA-Turner:remove-lingering-py2 // https://github.com/AA-Turner/docutils/compare/master...AA-Turner:remove-lingering-py2.patch ?

The pull request interface is useful for inline reviews and text, although of course Docutils uses SF so its of less use


---

** [patches:#188] Remove lingering references to Python 2**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 08:30 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 08:30 PM UTC
**Owner:** nobody


@milde

The first commit removes textual references, the remaining do some clean-up in `nodes` and `error_reporting` -- I don't know if these are helpful. I think at least the first commit should be applied, though.

https://github.com/AA-Turner/docutils/pull/4 // https://github.com/AA-Turner/docutils/pull/4.patch


---

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:patches] Re: #188 Remove lingering references to Python 2

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

On 2022-01-05, Adam Turner via Docutils-develop wrote in gmane.text.docutils.devel:

> The first commit removes textual references, the remaining do some
> clean-up in `nodes` and `error_reporting` -- I don't know if these are
> helpful. I think at least the first commit should be applied, though.

I prepared a commit based on patch 1 with some differences:

* Don't touch nodes.py (do all changes in this file in one commit).
* Don't touch error_reporting.py 
  (my plan is to first remove all uses in Docutils and then deprecate the
  module with a DeprecationWarning so no update needed inside).
* Don't touch punctuation_chars.py (it's a generated file!).
* Some additional formatting.

Do you want to have a look or may I just push?

> https://github.com/AA-Turner/docutils/pull/4 
> https://github.com/AA-Turner/docutils/pull/4.patch

(If Github would provide a "commitdiff" link similar to
https://repo.or.cz/w/docutils.git, you could just link to the commit or tree
with the patches without need for a pull request :)

Thank you for your work.



---

** [patches:#188] Remove lingering references to Python 2**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 08:30 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 08:30 PM UTC
**Owner:** nobody


@milde

The first commit removes textual references, the remaining do some clean-up in `nodes` and `error_reporting` -- I don't know if these are helpful. I think at least the first commit should be applied, though.

https://github.com/AA-Turner/docutils/pull/4 // https://github.com/AA-Turner/docutils/pull/4.patch


---

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:patches] Re: #186 Modernise packaging

[Adam T. <aa-...@us...>]

The symlink approach will absolutely still work :) 

I don't think anyone has suggested Docker -- that's far too complex!

Do you think you could merge the patch as currently proposed? If not, what are the blockers?

A


---

** [patches:#186] Modernise packaging**

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 12:53 PM UTC
**Owner:** nobody
**Attachments:**

- [0001-Use-flit-and-pyproject.toml.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0001-Use-flit-and-pyproject.toml.patch) (12.2 kB; application/octet-stream)
- [0002-Use-entry-points.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0002-Use-entry-points.patch) (20.7 kB; application/octet-stream)
- [0003-update-docs-etc-after-packaging-changes.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0003-update-docs-etc-after-packaging-changes.patch) (49.3 kB; application/octet-stream)


Hi,

I had a go at modernising the packaging stack. `setup.py` based invocations have been deprecated (https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html), and setuptools may remove them in the future. 

This takes the opportunity to move to a PEP 621 based declarative config, and also fixes a longstanding TODO item about providing script wappers for the frontend tools on windows, by migrating them to entry points.

I've updated install and development docs with the new guidance, and updated references to the frontend tools to remove `.py`, given they are now installed as proper scripts.

Hope this is appreciated -- happy to make revisions etc to help getting this merged.

A


---

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:patches] #187 Rename .txt files to .rst

[Adam T. <aa-...@us...>]

> Will windows ask what to do with .rst files

Yes, if you double click on the file it will open a pop-up asking what application you want to use to edit the files, and then you can select 'notepad' (preinstalled) or any other text editor. Windows can then remember the file association.

>  removng rst2html.py ... might be hard for people running the same script for 10 years

I do understand entirely -- any change is by its very nature breaking fron the status quo ante.

The latest patch I proposed though has no breaking changes (keeps `rst2html.py` etc), but less of the enhancements.

Can I take it that you'd support this change @grubert? (Trying to forge consensus!)

A

P.S. I have added an image of the file association pop-up box, as it is on my Windows 10 PC.


Attachments:

- [rst-file-assoc-popup.PNG](https://sourceforge.net/p/docutils/patches/_discuss/thread/c8407ba766/de6f/attachment/rst-file-assoc-popup.PNG) (30.6 kB; image/png)


---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Thu Jan 06, 2022 12:39 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:patches] Re: #186 Modernise packaging

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

I usually do this , set a symlink and work on.
And I very much appreciate not having to install docker and hub and whatever for development. 
But this is only me and I can change


---

** [patches:#186] Modernise packaging**

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 04:13 PM UTC
**Owner:** nobody
**Attachments:**

- [0001-Use-flit-and-pyproject.toml.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0001-Use-flit-and-pyproject.toml.patch) (12.2 kB; application/octet-stream)
- [0002-Use-entry-points.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0002-Use-entry-points.patch) (20.7 kB; application/octet-stream)
- [0003-update-docs-etc-after-packaging-changes.patch](https://sourceforge.net/p/docutils/patches/186/attachment/0003-update-docs-etc-after-packaging-changes.patch) (49.3 kB; application/octet-stream)


Hi,

I had a go at modernising the packaging stack. `setup.py` based invocations have been deprecated (https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html), and setuptools may remove them in the future. 

This takes the opportunity to move to a PEP 621 based declarative config, and also fixes a longstanding TODO item about providing script wappers for the frontend tools on windows, by migrating them to entry points.

I've updated install and development docs with the new guidance, and updated references to the frontend tools to remove `.py`, given they are now installed as proper scripts.

Hope this is appreciated -- happy to make revisions etc to help getting this merged.

A


---

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:patches] #187 Rename .txt files to .rst

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

Hei,

first of all I appreciate Adam nudging, although the project must slow him down, because not every docutils user is a programmer. For example removng rst2html.py is a 2 second change for Adam (more like 2 minutes for me) but might be hard for people running the same script for 10 years.

As for the file extension:

1. Adam's plea (very understandable) highlighting as the editor recognizes the file extension. 
2. Editing or viewing for normal users. Will windows ask what to do with .rst files ?

I don't know
cheers


---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 07:31 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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] #375 pypi docutils-python3 package

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

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

Closing this ticket. Thank you all for reports, research and patience.



---

** [bugs:#375] pypi docutils-python3 package**

**Status:** closed-fixed
**Created:** Tue Aug 20, 2019 07:13 AM UTC by Daniel
**Last Updated:** Wed Jan 05, 2022 08:47 PM UTC
**Owner:** nobody


When searching for `docutils` with pip (I wanted to install docutils to use rst2html in my project) I got a result including `docutils-python3`. That package only exists in version `0.13`.

The metadata on the pypi website is the same as for "docutils", except that `Programming Language :: Python` is only `3`.

The existence of this package is confusing. Users could install it instead of the original (this) one. They'd get an outdated, unmaintained version of unknown origin.

Could you ask the maintainer to remove it from pypi, or give a clear indication what the package is for and how it differs from upstream (this here)?
Thank you.


---

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:feature-requests] Re: #81 0.17.1: pytest is failing

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

This should be fixed in [r8933].
Thank you for the report.


---

** [feature-requests:#81] 0.17.1: pytest is failing**

**Status:** open
**Group:** 
**Created:** Sun Jun 27, 2021 03:07 AM UTC by Tomasz Kłoczko
**Last Updated:** Wed Jan 05, 2022 05:50 AM UTC
**Owner:** nobody


Just normal build, install and test cycle used on building package from non-root account:
- "setup.py build"
- "setup.py install --root </install/prefix>"
- "pytest with PYTHONPATH pointing to setearch and sitelib inside </install/prefix>

~~~
+ PYTHONPATH=/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib64/python3.8/site-packages:/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages
+ PYTHONDONTWRITEBYTECODE=1
+ /usr/bin/pytest -ra
=========================================================================== test session starts ============================================================================
platform linux -- Python 3.8.9, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
benchmark: 3.4.1 (defaults: timer=time.perf_counter disable_gc=False min_rounds=5 min_time=0.000005 max_time=1.0 calibration_precision=10 warmup=False warmup_iterations=100000)
Using --randomly-seed=2664516846
rootdir: /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1
plugins: forked-1.3.0, shutil-1.7.0, virtualenv-1.7.0, expect-1.1.0, httpbin-1.0.0, flake8-1.0.7, timeout-1.4.2, betamax-0.8.1, freezegun-0.4.2, case-1.5.3, isort-1.3.0, aspectlib-1.5.2, asyncio-0.15.1, toolbox-0.5, xprocess-0.17.1, aiohttp-0.3.0, checkdocs-2.7.0, mock-3.6.1, rerunfailures-9.1.1, requests-mock-1.9.3, cov-2.12.1, pyfakefs-4.5.0, cases-3.6.1, flaky-3.7.0, hypothesis-6.14.0, benchmark-3.4.1, xdist-2.3.0, pylama-7.7.1, randomly-3.8.0, Faker-8.8.2, datadir-1.3.1, regressions-2.2.0
collected 240 items

test/test_statemachine.py .................                                                                                                                          [  7%]
test/test_functional.py E                                                                                                                                            [  7%]
test/test_dependencies.py .....                                                                                                                                      [  9%]
test/test_parsers/test_get_parser_class.py ...                                                                                                                       [ 10%]
test/test_writers/test_latex2e_misc.py .                                                                                                                             [ 11%]
test/test_publisher.py ....                                                                                                                                          [ 12%]
test/test_writers/test_get_writer_class.py ...                                                                                                                       [ 14%]
test/test__init__.py ..                                                                                                                                              [ 15%]
. .                                                                                                                                                                  [ 15%]
test/test__init__.py ......                                                                                                                                          [ 17%]
test/test_settings.py ........................                                                                                                                       [ 28%]
test/test_writers/test_docutils_xml.py .....                                                                                                                         [ 30%]
test/test_parsers/test_parser.py .                                                                                                                                   [ 30%]
test/test_transforms/test___init__.py .                                                                                                                              [ 30%]
test/test_language.py EEEE                                                                                                                                           [ 32%]
test/test_traversals.py .                                                                                                                                            [ 33%]
test/test_writers/test_odt.py ..........                                                                                                                             [ 37%]
test/test_command_line.py F                                                                                                                                          [ 37%]
test/test_writers/test_html5_polyglot_parts.py EE                                                                                                                    [ 38%]
test/test_nodes.py ...............................                                                                                                                   [ 51%]
test/test_writers/test_html5_polyglot_misc.py ...............                                                                                                        [ 57%]
test/test_pickle.py .                                                                                                                                                [ 58%]
tools/test/test_buildhtml.py ..                                                                                                                                      [ 58%]
test/test_io.py .................                                                                                                                                    [ 66%]
test/test_readers/test_get_reader_class.py ...                                                                                                                       [ 67%]
test/test_error_reporting.py .............                                                                                                                           [ 72%]
test/test_writers/test_html4css1_misc.py ...............                                                                                                             [ 79%]
test/test_parsers/test_rst/test_directives/test_code_parsing.py ..                                                                                                   [ 79%]
test/test_utils.py ........................                                                                                                                          [ 89%]
test/test_parsers/test_recommonmark/test_misc.py ..Fs                                                                                                                [ 91%]
test/test_parsers/test_rst/test_directives/test__init__.py ....                                                                                                      [ 93%]
test/test_viewlist.py ................                                                                                                                               [100%]

================================================================================== ERRORS ==================================================================================
________________________________________________________________ ERROR at setup of FunctionalTestCase.test _________________________________________________________________

self = <[AttributeError("'FunctionalTestCase' object has no attribute '_testMethodName'") raised in repr()] FunctionalTestCase object at 0x7fbd75666df0>, args = ('test',)
kwargs = {}

    def __init__(self, *args, **kwargs):
        """Set self.configfile, pass arguments to parent __init__."""
>       self.configfile = kwargs['configfile']
E       KeyError: 'configfile'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_functional.py:95: KeyError
____________________________________________________________ ERROR at setup of LanguageTestCase.test_directives ____________________________________________________________

self = <[AttributeError("'LanguageTestCase' object has no attribute '_testMethodName'") raised in repr()] LanguageTestCase object at 0x7fbd754ce0d0>
args = ('test_directives',), kwargs = {}

    def __init__(self, *args, **kwargs):
        self.ref = docutils.languages.get_language(reference_language,
                                                   _reporter)
>       self.language = kwargs['language']
E       KeyError: 'language'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_language.py:81: KeyError
______________________________________________________________ ERROR at setup of LanguageTestCase.test_roles _______________________________________________________________

self = <[AttributeError("'LanguageTestCase' object has no attribute '_testMethodName'") raised in repr()] LanguageTestCase object at 0x7fbd753f98b0>, args = ('test_roles',)
kwargs = {}

    def __init__(self, *args, **kwargs):
        self.ref = docutils.languages.get_language(reference_language,
                                                   _reporter)
>       self.language = kwargs['language']
E       KeyError: 'language'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_language.py:81: KeyError
_______________________________________________________ ERROR at setup of LanguageTestCase.test_bibliographic_fields _______________________________________________________

self = <[AttributeError("'LanguageTestCase' object has no attribute '_testMethodName'") raised in repr()] LanguageTestCase object at 0x7fbd753c4850>
args = ('test_bibliographic_fields',), kwargs = {}

    def __init__(self, *args, **kwargs):
        self.ref = docutils.languages.get_language(reference_language,
                                                   _reporter)
>       self.language = kwargs['language']
E       KeyError: 'language'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_language.py:81: KeyError
______________________________________________________________ ERROR at setup of LanguageTestCase.test_labels ______________________________________________________________

self = <[AttributeError("'LanguageTestCase' object has no attribute '_testMethodName'") raised in repr()] LanguageTestCase object at 0x7fbd754181f0>
args = ('test_labels',), kwargs = {}

    def __init__(self, *args, **kwargs):
        self.ref = docutils.languages.get_language(reference_language,
                                                   _reporter)
>       self.language = kwargs['language']
E       KeyError: 'language'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_language.py:81: KeyError
______________________________________________________ ERROR at setup of HtmlWriterPublishPartsTestCase.test_publish _______________________________________________________

self = <[AttributeError("'HtmlWriterPublishPartsTestCase' object has no attribute '_testMethodName'") raised in repr()] HtmlWriterPublishPartsTestCase object at 0x7fbd54e7e550>
args = ('test_publish',), kwargs = {}

    def __init__(self, *args, **kwargs):
        if 'writer_name' in kwargs:
            self.writer_name = kwargs['writer_name']
            del kwargs['writer_name']
>       CustomTestCase.__init__(self, *args, **kwargs)
E       TypeError: __init__() missing 3 required positional arguments: 'input', 'expected', and 'id'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/DocutilsTestSupport.py:673: TypeError
______________________________________________________ ERROR at setup of Html5WriterPublishPartsTestCase.test_publish ______________________________________________________

self = <[AttributeError("'Html5WriterPublishPartsTestCase' object has no attribute '_testMethodName'") raised in repr()] Html5WriterPublishPartsTestCase object at 0x7fbd75348160>
args = ('test_publish',), kwargs = {}

    def __init__(self, *args, **kwargs):
        if 'writer_name' in kwargs:
            self.writer_name = kwargs['writer_name']
            del kwargs['writer_name']
>       CustomTestCase.__init__(self, *args, **kwargs)
E       TypeError: __init__() missing 3 required positional arguments: 'input', 'expected', and 'id'

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/DocutilsTestSupport.py:673: TypeError
================================================================================= FAILURES =================================================================================
_____________________________________________________________ CommandLineEncodingTests.test_sys_argv_decoding ______________________________________________________________

self = <docutils.frontend.OptionParser object at 0x7fbd54bba550>, args = ['-ra', '--source-url=test.txt', '--title=Dornröschen']
values = <Values at 0x7fbd54bba2e0: {'title': None, 'generator': True, 'datestamp': "%Y-%m-%d %H:%M UTC (If you see this in tes..._visitor': None, '_disable_config': None, '_source': None, '_destination': None, '_config_files': ['./docutils.conf']}>

    def parse_args(self, args=None, values=None):
        """
        parse_args(args : [string] = sys.argv[1:],
                   values : Values = None)
        -> (values : Values, args : [string])

        Parse the command-line options found in 'args' (default:
        sys.argv[1:]).  Any errors result in a call to 'error()', which
        by default prints the usage message to stderr and calls
        sys.exit() with an error message.  On success returns a pair
        (values, args) where 'values' is a Values instance (with all
        your option values) and 'args' is the list of arguments left
        over after parsing options.
        """
        rargs = self._get_args(args)
        if values is None:
            values = self.get_default_values()

        # Store the halves of the argument list as attributes for the
        # convenience of callbacks:
        #   rargs
        #     the rest of the command-line (the "r" stands for
        #     "remaining" or "right-hand")
        #   largs
        #     the leftover arguments -- ie. what's left after removing
        #     options and their arguments (the "l" stands for "leftover"
        #     or "left-hand")
        self.rargs = rargs
        self.largs = largs = []
        self.values = values

        try:
>           stop = self._process_args(largs, rargs, values)

/usr/lib64/python3.8/optparse.py:1387:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <docutils.frontend.OptionParser object at 0x7fbd54bba550>, largs = [], rargs = ['--source-url=test.txt', '--title=Dornröschen']
values = <Values at 0x7fbd54bba2e0: {'title': None, 'generator': True, 'datestamp': "%Y-%m-%d %H:%M UTC (If you see this in tes..._visitor': None, '_disable_config': None, '_source': None, '_destination': None, '_config_files': ['./docutils.conf']}>

    def _process_args(self, largs, rargs, values):
        """_process_args(largs : [string],
                         rargs : [string],
                         values : Values)

        Process command-line arguments and populate 'values', consuming
        options and arguments from 'rargs'.  If 'allow_interspersed_args' is
        false, stop at the first non-option argument.  If true, accumulate any
        interspersed non-option arguments in 'largs'.
        """
        while rargs:
            arg = rargs[0]
            # We handle bare "--" explicitly, and bare "-" is handled by the
            # standard arg handler since the short arg case ensures that the
            # len of the opt string is greater than 1.
            if arg == "--":
                del rargs[0]
                return
            elif arg[0:2] == "--":
                # process a single long option (possibly with value(s))
                self._process_long_opt(rargs, values)
            elif arg[:1] == "-" and len(arg) > 1:
                # process a cluster of short options (possibly with
                # value(s) for the last one only)
>               self._process_short_opts(rargs, values)

/usr/lib64/python3.8/optparse.py:1431:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <docutils.frontend.OptionParser object at 0x7fbd54bba550>, rargs = ['--source-url=test.txt', '--title=Dornröschen']
values = <Values at 0x7fbd54bba2e0: {'title': None, 'generator': True, 'datestamp': "%Y-%m-%d %H:%M UTC (If you see this in tes..._visitor': None, '_disable_config': None, '_source': None, '_destination': None, '_config_files': ['./docutils.conf']}>

    def _process_short_opts(self, rargs, values):
        arg = rargs.pop(0)
        stop = False
        i = 1
        for ch in arg[1:]:
            opt = "-" + ch
            option = self._short_opt.get(opt)
            i += 1                      # we have consumed a character

            if not option:
                raise BadOptionError(opt)
            if option.takes_value():
                # Any characters left in arg?  Pretend they're the
                # next arg, and stop consuming characters of arg.
                if i < len(arg):
                    rargs.insert(0, arg[i:])
                    stop = True

                nargs = option.nargs
                if len(rargs) < nargs:
                    self.error(ngettext(
                        "%(option)s option requires %(number)d argument",
                        "%(option)s option requires %(number)d arguments",
                        nargs) % {"option": opt, "number": nargs})
                elif nargs == 1:
                    value = rargs.pop(0)
                else:
                    value = tuple(rargs[0:nargs])
                    del rargs[0:nargs]

            else:                       # option doesn't take a value
                value = None

>           option.process(opt, value, values, self)

/usr/lib64/python3.8/optparse.py:1536:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <Option at 0x7fbd54edfd90: -r/--report>, opt = '-r', value = 'a'
values = <Values at 0x7fbd54bba2e0: {'title': None, 'generator': True, 'datestamp': "%Y-%m-%d %H:%M UTC (If you see this in tes..._visitor': None, '_disable_config': None, '_source': None, '_destination': None, '_config_files': ['./docutils.conf']}>
parser = <docutils.frontend.OptionParser object at 0x7fbd54bba550>

    def process(self, opt, value, values, parser):
        """
        Call the validator function on applicable settings and
        evaluate the 'overrides' option.
        Extends `optparse.Option.process`.
        """
>       result = optparse.Option.process(self, opt, value, values, parser)

/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/frontend.py:354:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <Option at 0x7fbd54edfd90: -r/--report>, opt = '-r', value = 'a'
values = <Values at 0x7fbd54bba2e0: {'title': None, 'generator': True, 'datestamp': "%Y-%m-%d %H:%M UTC (If you see this in tes..._visitor': None, '_disable_config': None, '_source': None, '_destination': None, '_config_files': ['./docutils.conf']}>
parser = <docutils.frontend.OptionParser object at 0x7fbd54bba550>

    def process(self, opt, value, values, parser):

        # First, convert the value(s) to the right type.  Howl if any
        # value(s) are bogus.
>       value = self.convert_value(opt, value)

/usr/lib64/python3.8/optparse.py:779:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <Option at 0x7fbd54edfd90: -r/--report>, opt = '-r', value = 'a'

    def convert_value(self, opt, value):
        if value is not None:
            if self.nargs == 1:
>               return self.check_value(opt, value)

/usr/lib64/python3.8/optparse.py:771:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <Option at 0x7fbd54edfd90: -r/--report>, opt = '-r', value = 'a'

    def check_value(self, opt, value):
        checker = self.TYPE_CHECKER.get(self.type)
        if checker is None:
            return value
        else:
>           return checker(self, opt, value)

/usr/lib64/python3.8/optparse.py:766:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

option = <Option at 0x7fbd54edfd90: -r/--report>, opt = '-r', value = 'a'

    def check_choice(option, opt, value):
        if value in option.choices:
            return value
        else:
            choices = ", ".join(map(repr, option.choices))
>           raise OptionValueError(
                _("option %s: invalid choice: %r (choose from %s)")
                % (opt, value, choices))
E           optparse.OptionValueError: option -r: invalid choice: 'a' (choose from 'info', '1', 'warning', '2', 'error', '3', 'severe', '4', 'none', '5')

/usr/lib64/python3.8/optparse.py:440: OptionValueError

During handling of the above exception, another exception occurred:

self = <test_command_line.CommandLineEncodingTests testMethod=test_sys_argv_decoding>

    def test_sys_argv_decoding(self):
        if argv_encoding == 'ascii': # cannot test
            return
        sys.argv.append('--source-url=test.txt') # pure ASCII argument
        if sys.version_info < (3, 0):
            sys.argv.append(u'--title=Dornröschen'.encode(argv_encoding))
        else:
            sys.argv.append(u'--title=Dornröschen')
        publisher = docutils.core.Publisher()
>       publisher.process_command_line()

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_command_line.py:41:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/core.py:162: in process_command_line
    self.settings = option_parser.parse_args(argv)
/usr/lib64/python3.8/optparse.py:1389: in parse_args
    self.error(str(err))
/usr/lib64/python3.8/optparse.py:1569: in error
    self.exit(2, "%s: error: %s\n" % (self.get_prog_name(), msg))
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <docutils.frontend.OptionParser object at 0x7fbd54bba550>, status = 2
msg = "pytest: error: option -r: invalid choice: 'a' (choose from 'info', '1', 'warning', '2', 'error', '3', 'severe', '4', 'none', '5')\n"

    def exit(self, status=0, msg=None):
        if msg:
            sys.stderr.write(msg)
>       sys.exit(status)
E       SystemExit: 2

/usr/lib64/python3.8/optparse.py:1559: SystemExit
--------------------------------------------------------------------------- Captured stderr call ---------------------------------------------------------------------------
Usage
=====
  pytest [options]

pytest: error: option -r: invalid choice: 'a' (choose from 'info', '1', 'warning', '2', 'error', '3', 'severe', '4', 'none', '5')
________________________________________________________________ reCommonMarkParserTests.test_parsing_error ________________________________________________________________

self = <test_parsers.test_recommonmark.test_misc.reCommonMarkParserTests testMethod=test_parsing_error>

    @unittest.skipUnless(recommonmark_wrapper.CommonMarkParser, skip_msg)
    def test_parsing_error(self):
>       output = publish_string(sample1, parser_name='recommonmark',
                                settings_overrides={'warning_stream': ''})

/home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_parsers/test_recommonmark/test_misc.py:55:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/core.py:407: in publish_string
    output, pub = publish_programmatically(
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/core.py:665: in publish_programmatically
    output = pub.publish(enable_exit_status=enable_exit_status)
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/core.py:217: in publish
    self.document = self.reader.read(self.source, self.parser,
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/readers/__init__.py:72: in read
    self.parse()
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/readers/__init__.py:78: in parse
    self.parser.parse(self.input, document)
/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/parsers/recommonmark_wrapper.py:117: in parse
    if node['level'] != section_level:
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

self = <section "title": <title...><paragraph...>>, key = 'level'

    def __getitem__(self, key):
        if isinstance(key, basestring):
>           return self.attributes[key]
E           KeyError: 'level'

/home/tkloczko/rpmbuild/BUILDROOT/python-docutils-0.17.1-2.fc35.x86_64/usr/lib/python3.8/site-packages/docutils/nodes.py:652: KeyError
============================================================================= warnings summary =============================================================================
test/test_parsers/test_recommonmark/test_section_headers.py:37
  /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_parsers/test_recommonmark/test_section_headers.py:37: DeprecationWarning: invalid escape sequence \
    """\

test/test_parsers/test_recommonmark/test_section_headers.py:50
  /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_parsers/test_recommonmark/test_section_headers.py:50: DeprecationWarning: invalid escape sequence \
    """\

test/test_parsers/test_recommonmark/test_section_headers.py:164
  /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_parsers/test_recommonmark/test_section_headers.py:164: DeprecationWarning: invalid escape sequence \
    """\

test/test_transforms/test___init__.py:20
  /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/test_transforms/test___init__.py:20: PytestCollectionWarning: cannot collect test class 'TestTransform' because it has a __init__ constructor (from: test/test_transforms/test___init__.py)
    class TestTransform(transforms.Transform):

test/test_settings.py::ConfigFileTests::test_old
test/test_settings.py::ConfigFileTests::test_old_and_new
test/test_settings.py::ConfigEnvVarFileTests::test_old_and_new
test/test_settings.py::ConfigEnvVarFileTests::test_old
  /home/tkloczko/rpmbuild/BUILD/docutils-0.17.1/test/data/config_old.txt:0: ConfigDeprecationWarning:
  The "[option]" section is deprecated.  Support for old-format configuration
  files may be removed in a future Docutils release.  Please revise your
  configuration files.  See <http://docutils.sf.net/docs/user/config.html>,
  section "Old-Format Configuration Files".

test/test_parsers/test_recommonmark/test_misc.py::reCommonMarkParserTests::test_raw_disabled_inline
test/test_parsers/test_recommonmark/test_misc.py::reCommonMarkParserTests::test_raw_disabled
test/test_parsers/test_recommonmark/test_misc.py::reCommonMarkParserTests::test_parsing_error
  /usr/lib/python3.8/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document
    warn("Container node skipped: type={0}".format(mdnode.t))

-- Docs: https://docs.pytest.org/en/stable/warnings.html
========================================================================= short test summary info ==========================================================================
SKIPPED [1] test/test_parsers/test_recommonmark/test_misc.py:91: recommonmark_wrapper: parser found, fallback not used
ERROR test/test_functional.py::FunctionalTestCase::test - KeyError: 'configfile'
ERROR test/test_language.py::LanguageTestCase::test_directives - KeyError: 'language'
ERROR test/test_language.py::LanguageTestCase::test_roles - KeyError: 'language'
ERROR test/test_language.py::LanguageTestCase::test_bibliographic_fields - KeyError: 'language'
ERROR test/test_language.py::LanguageTestCase::test_labels - KeyError: 'language'
ERROR test/test_writers/test_html5_polyglot_parts.py::HtmlWriterPublishPartsTestCase::test_publish - TypeError: __init__() missing 3 required positional arguments: 'inpu...
ERROR test/test_writers/test_html5_polyglot_parts.py::Html5WriterPublishPartsTestCase::test_publish - TypeError: __init__() missing 3 required positional arguments: 'inp...
FAILED test/test_command_line.py::CommandLineEncodingTests::test_sys_argv_decoding - SystemExit: 2
FAILED test/test_parsers/test_recommonmark/test_misc.py::reCommonMarkParserTests::test_parsing_error - KeyError: 'level'
===================================================== 2 failed, 229 passed, 1 skipped, 11 warnings, 7 errors in 10.64s =====================================================
~~~


---

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] #375 pypi docutils-python3 package

[Adam T. <aa-...@us...>]

I think this can be closed, https://pypi.org/project/docutils-python3/ is now 404.

A


---

** [bugs:#375] pypi docutils-python3 package**

**Status:** open
**Created:** Tue Aug 20, 2019 07:13 AM UTC by Daniel
**Last Updated:** Tue Mar 03, 2020 09:41 PM UTC
**Owner:** nobody


When searching for `docutils` with pip (I wanted to install docutils to use rst2html in my project) I got a result including `docutils-python3`. That package only exists in version `0.13`.

The metadata on the pypi website is the same as for "docutils", except that `Programming Language :: Python` is only `3`.

The existence of this package is confusing. Users could install it instead of the original (this) one. They'd get an outdated, unmaintained version of unknown origin.

Could you ask the maintainer to remove it from pypi, or give a clear indication what the package is for and how it differs from upstream (this here)?
Thank you.


---

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] #188 Remove lingering references to Python 2

[Adam T. <aa-...@us...>]

---

** [patches:#188] Remove lingering references to Python 2**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 08:30 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 08:30 PM UTC
**Owner:** nobody


@milde

The first commit removes textual references, the remaining do some clean-up in `nodes` and `error_reporting` -- I don't know if these are helpful. I think at least the first commit should be applied, though.

https://github.com/AA-Turner/docutils/pull/4 // https://github.com/AA-Turner/docutils/pull/4.patch


---

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:patches] #187 Rename .txt files to .rst

[Adam T. <aa-...@us...>]

The links didn't render for some reason, let me try again:

1:  https://python.github.io/peps/pep-0012/
2:  https://github.com/python/cpython/tree/8ec7f656134b1230ab23003a94ba3266d7064122/Doc
3:  https://en.wikipedia.org/w/index.php?title=ReStructuredText&diff=487960232&oldid=487396784
4:  https://github.com/torvalds/linux/commit/22cba31bae9dc357622f09d22b82ca5a112b4fde#diff-65f82f80279ec12ce6d19e0a686d262618611be80d1a264e1cffed0d14c814a4
5:  https://github.com/github/linguist/blob/37243ec6bed3e697beeb874fc94efb9e42ca7f8c/lib/linguist/extensions.yml#L502-L506


---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 07:29 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:patches] #187 Rename .txt files to .rst

[Adam T. <aa-...@us...>]

Hi Günter,

That text was written in 2002 -- twenty years ago.

I would argue that the *de facto*  reality is that ".rst" **is** the standard extension for reStructuredText files, and has been for quite some time -- it is required for Python Enhancement Proposals (PEP 12 [1]) and the Python documentation (since 2007 [2]). Wikipedia has used the `.rst` extension for 10 years [3]. The linux kernel has been using `.rst` files for 5 years, when they switched to reStructuredText [4]. Any tool using `linguist` will pick up `.rst` as the extension (since the start of the project in 2011) [5].

I could go on! My plea is to update the FAQ -- my suggested edit notes that "ReStructuredText files should be readable as plaintext", which I believe is in spirit of the original text. In response to the "why bother" comment in the original FAQ text -- I would argue it is as the rest of the world seems to assume that the extension is `.rst`, and Docutils as the official custodian of reStructuredText should embrace this.

A

---

Original FAQ text:

>**What's the standard filename extension for a reStructuredText file?:**
> It's ".txt".  Some people would like to use ".rest" or ".rst" or
> ".restx", but why bother?  ReStructuredText source files are meant to
> be readable as plaintext, and most operating systems already associate
> ".txt" with text files.  Using a specialized filename extension would
> require that users alter their OS settings, which is something that
> many users will not be willing or able to do.


[1]: https://python.github.io/peps/pep-0012/
[2]: https://github.com/python/cpython/tree/8ec7f656134b1230ab23003a94ba3266d7064122/Doc
[3]: https://en.wikipedia.org/w/index.php?title=ReStructuredText&diff=487960232&oldid=487396784
[4]: https://github.com/torvalds/linux/commit/22cba31bae9dc357622f09d22b82ca5a112b4fde#diff-65f82f80279ec12ce6d19e0a686d262618611be80d1a264e1cffed0d14c814a4
[5]: https://github.com/github/linguist/blob/37243ec6bed3e697beeb874fc94efb9e42ca7f8c/lib/linguist/extensions.yml#L502-L506


---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 06:49 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:patches] #187 Rename .txt files to .rst

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

Docutils is quite clear about the [standard filename extension for a reStructuredText file](https://docutils.sourceforge.io/FAQ.html#what-s-the-standard-filename-extension-for-a-restructuredtext-file), so I don't see this accepted anytime soon.

The [policies](https://docutils.sourceforge.io/docs/dev/policies.html#documentation-conventions) advise:

> * Add an Emacs "local variables" block in a comment at the end of the document. See the end of this document for an example.

Compatible editors can use this to set the editing mode.

In the [jed programmer's editor](https://www.jedsoft.org/jed), I use a hook
~~~S-Lang
% set rst (reStructured Text) mode for some cases
define text_mode_hook()
{
   % Set rst_mode for text files in the Docutils SVN working dir
   % and the Docutils test dir
   if ((is_substr(buffer_filename(), "docutils") or
       is_substr(buffer_filename(), "Test/Docutils"))
       and not is_substr(buffer_filename(), "Makefile")) {
      rst_mode();
      return(1);
   }
 % ...
 }
~~~
Maybe something similar is available in other "intelligent" editors, too.


---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 05:51 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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:feature-requests] #86 Replace recommonmark with myst-docutils

[Chris S. <chr...@us...>]

Well thank you for your help Clement!

> Agreed. So we may close the ticket as "open-fixed"?

Sounds good to me thanks, and don't hesitate to get in touch for any other related issues :)


---

** [feature-requests:#86] Replace recommonmark with myst-docutils**

**Status:** open
**Group:** Default
**Created:** Sun Jan 02, 2022 01:26 PM UTC by Chris Sewell
**Last Updated:** Sun Jan 02, 2022 04:53 PM UTC
**Owner:** nobody


Hey guys,

As discussed in https://github.com/readthedocs/recommonmark/issues/221, recommonmark has been officially deprecated in favour of https://github.com/executablebooks/MyST-Parser/.

In myst-parser v0.16, I added first-class support for direct docutils use (as opposed to via sphinx) and introduced the parallel https://pypi.org/project/myst-docutils/ distribution, which is myst-parser but without explicit install requirements on docutils or sphinx, i.e. you can install myst-docutils with any version of docutils and it will work without sphinx installed.

receive(see https://github.com/executablebooks/MyST-Parser/blob/master/CHANGELOG.md#0160---2021-12-06, https://github.com/executablebooks/MyST-Parser/issues/347, and https://myst-parser.readthedocs.io/en/latest/docutils.html) 
receive
receiveIn the master branch (and soon to be myst-docutils v0.17) I have also been working to improve the rigour of the behaviour/testing against this parser.
(as an example, I believe your current recommonmark solution does not actually work properly with code fences, because it does not syntax highlight the code, see: https://github.com/executablebooks/MyST-Parser/pull/478)

The fixture test sets, essentially provide a full specification of the Markdown -> docutils AST conversion (pre-docutils-transforms):

- https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_syntax_elements.md
- https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_roles.md
-  https://raw.githubusercontent.com/executablebooks/MyST-Parser/master/tests/test_renderers/fixtures/docutil_directives.md

and are currently tested in the CI for myst-docutils against docutils v0.16, v0.17 and v0.18: https://github.com/executablebooks/MyST-Parser/runs/4670995311?check_suite_focus=true

I'm also happy to recieve any feedback /  improvement suggestions to facilitate this, and have opened a parallel discussion topic here: https://github.com/executablebooks/MyST-Parser/discussions/487

Cheer,
Chris



---

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:patches] #187 Rename .txt files to .rst

[Adam T. <aa-...@us...>]

---

** [patches:#187] Rename .txt files to .rst**

**Status:** open
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Wed Jan 05, 2022 05:51 PM UTC
**Owner:** nobody


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

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.