docutils-develop — For developer discussions of the implementation.

Re: [Docutils-develop] Add a new language [Valencian as a dialect of Catalan]

[Antoni B. P. <ant...@ya...>]

divendres, 28 de juliol de 2023, a les 9:31:36 (CEST), engelbert gruber va 
escriure:
> Hei
> 
> I have to look and search too ...
> 
> ca-va (ca_va for the module) ... looks good to me
> 
> all the best and slower response currently ... sorry

  Thank you very much for the reply,

  'va' isn't any country, as a variant it should be 'ca-va' (without the 
underscore), which is the translation of 'ca@va'.

  We've been thinking about changing '@valencia' to fit the required two-letter 
standard for some time. It wasn't clear before and now... some problems are 
overwhelming. We have to discuss it with the Valencians and developers in 
order to make the change.

  Can docutils support 'ca-va'?

  Note you that if the country is added it would be 'ca-va_es' (it is only 
presented in order to understand the subject) which is not desired by any 
side.

> On Wed, 26 Jul 2023 at 18:14, Antoni Bella Pérez via Docutils-develop <
> 
> doc...@li...> wrote:
> >   Hi,
> >   
> >   I need help to decide what needs to be added to docutils so that
> > 
> > Valencian
> > language be admitted as a language. As a note, I would like to state that
> > we
> > 
> > reuse Catalan as much as possible:
> >   - The 'ca' translations in docutils too - no need to touch them
> >   - The language code used for the generated web pages is 'ca-va'
> >   - The language code for the translations is 'ca@valencia'
> >   
> >   - locale used in my system is 'ca_ES.UTF-8@valencia':
> >     [ ] ca_AD ISO-8859-15
> >     [ ] ca_AD.UTF-8 UTF-8
> >     [*] ca_ES ISO-8859-1
> >     [*] ca_ES.UTF-8 UTF-8
> >     [*] ca_ES.UTF-8@valencia UTF-8
> >     [*] ca_ES@euro ISO-8859-15
> >     [*] ca_ES@valencia ISO-8859-15
> >     [*] ca_ES@valencia UTF-8
> >     [ ] ca_FR ISO-8859-15
> >     [ ] ca_FR.UTF-8 UTF-8
> >     [ ] ca_IT ISO-8859-15
> >     [ ] ca_IT.UTF-8 UTF-8
> >   
> >   * Valencian is a dialect of Catalan:
> >     - https://en.wikipedia.org/wiki/Valencian_language
> >     - https://en.wikipedia.org/wiki/Catalan_Countries
> > 
> > ## IANA registry
> > #
> > http://www.iana.org/assignments/language-subtag-registry/language-subtag-r
> > egistry
> > 
> > Type: language
> > Subtag: ca
> > Description: Catalan
> > Description: Valencian
> > Added: 2005-10-16
> > Suppress-Script: Latn
> > 
> > Type: variant
> > Subtag: valencia
> > Description: Valencian
> > Added: 2007-03-06
> > Prefix: ca
> > Comments: Variety spoken in the "Comunidad Valenciana" region of Spain,
> > 
> >   where it is co-official with Spanish.
> > 
> > --
> > 
> > ## ISO 639-2
> > # https://www.loc.gov/standards/iso639-2/php/English_list.php
> > 
> > Catalan    Catalan; Valencian  catalan; valencien  cat  ca
> > Valencian  Catalan; Valencian  catalan; valencien  cat  ca
> > --
> > 
> >   The reason is to be able to generate content with Sphinx.
> >   
> >   With all this, how do you see it?

  Regards
  Toni
-- 
Dubta que les estrelles siguin foc.
Dubta que el Sol es mogui.
Dubta que la veritat sigui mentida.
Però no dubtis mai que t'estimo.
	- William Shakespeare

No se n'ha de posar massa
	- A grandmother on the TV show "Las recetas de Julie"

[Docutils-develop] [docutils:patches] #205 [manpage] Change macros for literal block to avoid warnings from groff 1.23

[Dmitry S. <man...@us...>]

---

**[patches:#205] [manpage] Change macros for literal block to avoid warnings from groff 1.23**

**Status:** open
**Group:** None
**Labels:** manpage 
**Created:** Sat Jul 29, 2023 05:05 PM UTC by Dmitry Shachnev
**Last Updated:** Sat Jul 29, 2023 05:05 PM UTC
**Owner:** nobody
**Attachments:**

- [manpage_literal_block.patch](https://sourceforge.net/p/docutils/patches/205/attachment/manpage_literal_block.patch) (627 Bytes; text/x-patch)


Docutils manpage writer currently uses `.ft C`, but this causes warnings from groff ≥ 1.23.0.

Please see the downstream bug https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1041809 for a discussion about this issue with many references.

The attached patch, based on the original patch from G. Branden Robinson, fixes the warnings and makes the manpage writer use `.EX` and `.EE` instead, which are documented [here](https://manpages.debian.org/unstable/groff/groff_man.7.en.html#Document_structure_macros):

> Begin and end example. After .EX, filling is disabled and a constant-width (monospaced) font is selected. Calling .EE enables filling and restores the previous font.

So this should be equivalent to the previous code (`.nf`/`.fi` was for the filling, `.ft C`/`.ft P` was for the font).


---

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] Add a new language [Valencian as a dialect of Catalan]

[Antoni B. P. <ant...@ya...>]

  Hi,

  I need help to decide what needs to be added to docutils so that Valencian 
language be admitted as a language. As a note, I would like to state that we 
reuse Catalan as much as possible:

  - The 'ca' translations in docutils too - no need to touch them
  - The language code used for the generated web pages is 'ca-va'
  - The language code for the translations is 'ca@valencia'
  - locale used in my system is 'ca_ES.UTF-8@valencia':
    [ ] ca_AD ISO-8859-15
    [ ] ca_AD.UTF-8 UTF-8
    [*] ca_ES ISO-8859-1
    [*] ca_ES.UTF-8 UTF-8
    [*] ca_ES.UTF-8@valencia UTF-8
    [*] ca_ES@euro ISO-8859-15
    [*] ca_ES@valencia ISO-8859-15
    [*] ca_ES@valencia UTF-8
    [ ] ca_FR ISO-8859-15
    [ ] ca_FR.UTF-8 UTF-8
    [ ] ca_IT ISO-8859-15
    [ ] ca_IT.UTF-8 UTF-8

  * Valencian is a dialect of Catalan:
    - https://en.wikipedia.org/wiki/Valencian_language
    - https://en.wikipedia.org/wiki/Catalan_Countries

## IANA registry
# http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry

Type: language
Subtag: ca
Description: Catalan
Description: Valencian
Added: 2005-10-16
Suppress-Script: Latn

Type: variant
Subtag: valencia
Description: Valencian
Added: 2007-03-06
Prefix: ca
Comments: Variety spoken in the "Comunidad Valenciana" region of Spain,
  where it is co-official with Spanish.
--

## ISO 639-2
# https://www.loc.gov/standards/iso639-2/php/English_list.php

Catalan    Catalan; Valencian  catalan; valencien  cat  ca
Valencian  Catalan; Valencian  catalan; valencien  cat  ca
--

  The reason is to be able to generate content with Sphinx.

  With all this, how do you see it?

  Regards
  Toni
-- 
Dubta que les estrelles siguin foc.
Dubta que el Sol es mogui.
Dubta que la veritat sigui mentida.
Però no dubtis mai que t'estimo.
	- William Shakespeare

No se n'ha de posar massa
	- A grandmother on the TV show "Las recetas de Julie"

[Docutils-develop] [docutils:bugs] #153 Image directive URI handled incorrectly in ODT output

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

- **status**: open --> open-fixed
- **assigned_to**: Dave Kuhlman -->  nobody 
- **Comment**:

The provided example still fails with Docutils 0.20.
Fixed in [r9422].
Thank you for reporting.



---

**[bugs:#153] Image directive URI handled incorrectly in ODT output**

**Status:** open-fixed
**Labels:** ODT Writer 
**Created:** Fri Dec 03, 2010 10:09 PM UTC by GCompton
**Last Updated:** Fri Dec 03, 2010 10:09 PM UTC
**Owner:** nobody


The ODT writer has two problems with the way it handles the URIs provided in image \(and figure\) directives.  First, it does not unescape them before passing them to the local file system. Second, it dereferences relative to the current working directory, not relative to the directory reST file.

The first case causes problems with images whose file names contain characters that can't be used in URIs without escaping.  I ran into it because my files have spaces in their names.  In order to get the HTML writer to work, I had to refer to the files using "%20" in place of each space.  Not ideal, but acceptable.  However, the ODT writer takes the image node's uri member and passes it directly to os.path.exists \(In writers/odt\_odt/\_\_init\_\_.py in the function check\_file\_exists\) as though it were a file system path rather than a URI.  Of course, on the file system, the file name has spaces, not %20s, so it couldn't find it.  This part of the problem could probably be solved by passing the uri through the standard urllib.url2pathname function before calling any file system functions.  

The second problem showed up when I tried to perform the generation with a current directory other than the one containing the reST file.  In general, relative URIs are resolved against the directory containing the referring document \(I couldn't find anything in the reST documentation declaring an exception, so I expect the common behavior\).  But, again, because the ODT writer doesn't modify the URI at all before using it as a path, Python's file system functions assume it is relative to the working directory.  The solution here is probably to prepend the path from the working directory to the reST file's directory.  

These problems may be more general than what I've seen so far.  The other writers may be affected.  Also, the other directives cause external files to be read may have similar problems.

I'm using docutils 0.7 with Python 2.7 32-bit running on Windows 7 Professional 64-bit.


---

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] #67 latex2e: recorddeps to images rel to CWD (+ lots of fixes)

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

- **status**: open --> closed-out-of-date
- **Group**:  --> None
- **Comment**:

Thank you for the patch set  and comprehensive explanations.

It is obsoleted by [r7256] from 2011-12-15 which did 
"drop latex2e exception: Record only files required to generate the LaTeX source."

Regarding the "source"   and "line" arguments for inline nodes, the decision was taken to keep it simple :

* ``utils.get_source_line(node)`` now returns the values for parent nodes if a node has no source and line attributes.
* The source can only change in block elements (as "include" does not work inline).
* Docutils reports errors only with the start-line of the releavant block element.




---

**[patches:#67] latex2e: recorddeps to images rel to CWD (+ lots of fixes)**

**Status:** closed-out-of-date
**Group:** None
**Created:** Mon Mar 01, 2010 05:02 PM UTC by Kirill Smelkov
**Last Updated:** Mon Mar 01, 2010 05:06 PM UTC
**Owner:** nobody


Subject: \[PATCH 1/8\] Node.copy: don't forget to also setup .document/.source/.line in duplicate

Spot this by debugging Substitute transformation which does .deepcopy\(\)
to substitute definitions.

This will be needed in the next patch, where I'll be teaching Inliner to
propagate .line for \`inline' elements.
\---
docutils/docutils/nodes.py |   23 +++++++++++++++++++----
1 files changed, 19 insertions\(+\), 4 deletions\(-\)



---

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

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

Commit [r9407] changed setup.py to use "console_scripts" entry points instead of copying tools/rst2*.py scripts.
With this, the move to modern packagaging tools should be possible without affecting what is installed.


---

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

**Status:** open
**Group:** None
**Created:** Fri Dec 31, 2021 03:16 AM UTC by Adam  Turner
**Last Updated:** Fri Jun 03, 2022 11:09 AM 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:feature-requests] #88 Unify Docutils CLI tools into `docutils-cli`

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

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

Commit [r9408] implemented the switch from installing ``rst2*.py`` scripts into the binary PATH to "console-scripts" entry point definitions.
"Console-scripts" entry points are now:
* ``docutils``: the generic front end
* ``rst2*`` (without  extension``.py``): specific end-user applications.
The corresponding scripts in ``tools/`` are kept in the repository and source distribution as examples for custom front-ends and possible use by distribution packagers.

This should also clear the way to replace "setup.py" with a TOML config file [patches:#186].



---

**[feature-requests:#88] Unify Docutils CLI tools into `docutils-cli`**

**Status:** open-fixed
**Group:** Default
**Created:** Sat Jan 15, 2022 10:11 PM UTC by Adam  Turner
**Last Updated:** Fri Dec 02, 2022 12:41 AM UTC
**Owner:** nobody


As noted at https://sourceforge.net/p/docutils/patches/186/?page=1#897a/547e/ef2d by @milde, 
> we should open a new ticket for the command line tool review

This is a tracker issue for this, and to allow discussion. 

I'll briefly re-outline my argument to (eventually) drop the `rst*` front-end tools, and only export `docutils-cli` (or `python -m docutils`). 

> I think a single front-end tool significantly simplifies a lot of things -- the docutils-cli wrapper is not complex, which gives it significant points in favour in my book.

> Most usage of Docutils today is programmatic, and not via the command line tools (see the table at the bottom of this post - it shows all the projects that have a full dependency on Docutils with over 500k downloads in the last month. Of those 8, none use the command line tools)

> I also suspect (although the data does not exist) that most command line uses of the Docutils tools will be rst2html(5). This is already the default in docutils-cli, so it is a drop-in replacement.

> ...

>  My proposal isn't to remove them *\[the rst2 front-end tools\]* with no recourse, but to deprecate over a period of time, clearly marking identical drop-in commands at runtime to affected users. ... We cannot know how many people would be affected with local random scripts, but it is a two-second change.

> Many users will also run with old or pinned versions of Docutils, and part of updating is seeing the changelog. If Debian or other redistributors already make changes, they could decide to keep shell aliases from rst2* to the new docutils-cli based invocations. 

(quotes taken from https://sourceforge.net/p/docutils/patches/186/#897a and https://sourceforge.net/p/docutils/patches/186/?page=1#897a/547e )

A


---

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:feature-requests] #93 Mod operator for math2html

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

- **status**: open --> pending
- **Comment**:

Unless someone comes up with a patch for math2html, I plan to close this as "works for me" (with the "mathML" math-output setting).



---

**[feature-requests:#93] Mod operator for math2html**

**Status:** pending
**Group:** Default
**Created:** Sat Sep 03, 2022 08:43 PM UTC by Daniel James Perry
**Last Updated:** Thu May 11, 2023 08:02 AM UTC
**Owner:** nobody


The latex to html/css code is quite impressive, but it's missing the `\\mod` command (as well as other similar commands like `\\pmod`. It should be a trivial thing to do.

BTW please get with the times and start using git PLEASE.


---

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:feature-requests] #91 Include directive path argument should support a configurable root.

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

The updated patch now provides a configurable root directory for file paths in the "include", "raw", and "csv-table" directives + documentation and tests.

Before it can be applied to master, we need a decision on the behaviour of image URLs when interpreted as file path (i.e. whenever Docutils needs to access locally saved images: embedded images, LaTeX writer, reading meta-data from the image with PIL).
IMV, it would make sense to apply the "include-root" setting also in this context.


Attachments:

- [0001-Config-setting-include-root-configurable-root-direct.patch](https://sourceforge.net/p/docutils/feature-requests/_discuss/thread/a885b6f1ca/7d1d/attachment/0001-Config-setting-include-root-configurable-root-direct.patch) (9.7 kB; text/x-patch)


---

**[feature-requests:#91] Include directive path argument should support a configurable root.**

**Status:** open
**Group:** Default
**Created:** Tue May 03, 2022 04:03 PM UTC by Michal Urbanski
**Last Updated:** Thu Dec 01, 2022 11:07 PM UTC
**Owner:** nobody


I'm building a static website using restructuredtext and I'm really annoyed by the lack of support for root-relative paths.

I have already implemented multiple directive plugins for my website build process, some of which use external files in a different format. They use the convention that if a path begins with /, they are relative to the root directory of the project.

IMO the requirement for relative paths is very limiting - I could have a directory with files intended for inclusion but:

- I would need to use `../../` which is very ugly
- relative paths are different depending on the current file path - this is very fragile and limits 

An additional argument is that C and C++ have been using #include for like 40 years and relative paths (while sometimes useful) are only for specific cases. The leading convention is to use root-relative paths.

I could implement another plugin for it but ... copy-pasting docutils own code only to change few lines is definitely smelly.


---

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] #440 longtable labels in the wrong place

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

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

Fixed in [r9401]. Thank you for reporting.



---

**[bugs:#440] longtable labels in the wrong place**

**Status:** open-fixed
**Created:** Tue Dec 21, 2021 11:39 PM UTC by Erik Hansen
**Last Updated:** Thu May 25, 2023 12:16 PM UTC
**Owner:** nobody
**Attachments:**

- [0001-Move-longtable-labels-to-table-body.patch](https://sourceforge.net/p/docutils/bugs/440/attachment/0001-Move-longtable-labels-to-table-body.patch) (1.7 kB; text/x-patch)


The latex2e writer outputs `\label{}` for tables after `\end{longtable}`. This is incorrect causing the table referencing to end up with empty reference text rather than the table number. The author of the `longtable` latex package suggest putting the `\label{}` inside the caption itself  `\caption{My caption \label{mylabel}}` or inside the table body. The latter option has the added benefit of working for tables without  a caption. I've attached a proposed fix.

`longtable` package documentation can be found at https://mirror.ox.ac.uk/sites/ctan.org/macros/latex/required/tools/longtable.pdf. See page 4 and 5 about the discussion on labeling.


---

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] #95 License "Python 2.1.1" doesn't exist as an SPDX identifier

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

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

Fixed in [r9398].



---

**[feature-requests:#95] License "Python 2.1.1" doesn't exist as an SPDX identifier**

**Status:** open-fixed
**Group:** Default
**Created:** Mon May 15, 2023 08:37 AM UTC by Karolina Surma
**Last Updated:** Tue May 30, 2023 09:45 AM UTC
**Owner:** nobody


Hello,
in an effort to declare the licenses according to the SPDX standards we're now going through in Fedora Linux, we've come across an issue with the Python 2.1.1 license - there's no such SPDX identifier.
The license is declared in the COPYING file and the text is additionally shipped with the software.
https://sourceforge.net/p/docutils/code/HEAD/tree/tags/docutils-0.20/COPYING.txt#l131

I asked the [Fedora Legal Team]( https://gitlab.com/fedora/legal/fedora-license-data/-/issues/216#note_1387584572) how to proceed, an the answer was:

> What Mark Pilgrim actually said in Dive Into Python:
"The example programs in this book are free software; you can redistribute and/or modify them under the terms of the Python license as published by the Python Software Foundation. A copy of the license is included in Appendix H, Python license."
I am tempted to say that we should interpret this as meaning that it is just the PSF license that he intended to cover the example code (with some implied customization as to licensor and software), despite the fact that Appendix H includes a copy of a variant of the CPython stack license (faithfully reproduced by the docutils project).
If I were involved in the docutils project, I would suggest they replace the Python 2.1.1 license text with some sort of instantiation of the PSF-2.0 license text, and possibly attempt to get in touch with Mark Pilgrim to confirm that this is appropriate.

Would it be possible to do so?


---

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] #472 Node.previous_sibling is broken

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

- **status**: open --> closed-fixed
- **Priority**: 8 --> 5
- **Comment**:

This is a duplicate of [patches:#195], fixed in  Docutils 0.20.
Thanks for reporting, anyway.



---

**[bugs:#472] Node.previous_sibling is broken**

**Status:** closed-fixed
**Created:** Mon Jun 05, 2023 03:42 PM UTC by flying sheep
**Last Updated:** Mon Jun 05, 2023 03:53 PM UTC
**Owner:** nobody


It doesn’t work as advertised, as it never returns `None`.

~~~
def previous_sibling(self):
    """Return preceding sibling node or ``None``."""
    try:
        return self.parent[self.parent.index(self)-1]
    except (AttributeError, IndexError):
        return None
~~~

This means that when `self` is the first child, i.e. `self.parent.index(self) == 0`,  then `self.parent[-1]` is returned. The last child, not `None`. If `len(node.parent) == 1`, that means `node.previous_sibling() is node`.

This in turn means that the HTML writer for `citation` elements will emit broken HTML, see https://github.com/mcmtroffaes/sphinxcontrib-bibtex/issues/329

This is pretty severe since it leads to broken HTML markup and therefore completely broken page layout.


---

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] #440 longtable labels in the wrong place

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

Thank you for the additional info, it helped to reproduce the problem.
Mind, that for references to section numbers with `reference-label: ref`, you need to activate section numbering by LaTeX (`sectnum-xform: False`), Docutils-generated section numbers  do not show up (cf. the documentation fixes in [r9395]
With at least one LaTeX-numbered section in the document, a `\ref` to a table with title/caption (and hence Table number) also works with the `\label` placed after the table, so setting [sectnum-xform](https://docutils.sourceforge.io/docs/user/config.html#sectnum-xform) to  `False` for the LaTeX writer (or using the somewhat misleading command line option `--no-section-numbering`) might provide a fast workaround.

Does the attached patch (against [r9395]) solve the problem?


Attachments:

- [0001-LaTeX-writer-fix-placement-of-hyperlink-target-label-for-tables.patch](https://sourceforge.net/p/docutils/bugs/_discuss/thread/0d2d55e26b/0adc/attachment/0001-LaTeX-writer-fix-placement-of-hyperlink-target-label-for-tables.patch) (8.2 kB; text/x-patch)


---

**[bugs:#440] longtable labels in the wrong place**

**Status:** pending-remind
**Created:** Tue Dec 21, 2021 11:39 PM UTC by Erik Hansen
**Last Updated:** Thu Dec 30, 2021 03:56 AM UTC
**Owner:** nobody
**Attachments:**

- [0001-Move-longtable-labels-to-table-body.patch](https://sourceforge.net/p/docutils/bugs/440/attachment/0001-Move-longtable-labels-to-table-body.patch) (1.7 kB; text/x-patch)


The latex2e writer outputs `\label{}` for tables after `\end{longtable}`. This is incorrect causing the table referencing to end up with empty reference text rather than the table number. The author of the `longtable` latex package suggest putting the `\label{}` inside the caption itself  `\caption{My caption \label{mylabel}}` or inside the table body. The latter option has the added benefit of working for tables without  a caption. I've attached a proposed fix.

`longtable` package documentation can be found at https://mirror.ox.ac.uk/sites/ctan.org/macros/latex/required/tools/longtable.pdf. See page 4 and 5 about the discussion on labeling.


---

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: #72 rst2man: Show reference targets

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

For printouts of links at a specified place, rST provides the [target-notes](https://docutils.sourceforge.io/docs/ref/rst/directives.html#target-footnotes) directive.


---

**[feature-requests:#72] rst2man: Show reference targets**

**Status:** open
**Group:** Default
**Created:** Wed Aug 26, 2020 03:47 PM UTC by Petr Viktorin
**Last Updated:** Sat May 20, 2023 09:34 AM UTC
**Owner:** engelbert gruber


Currently, the manpage writer writes a reference like `ALT TEXT <URL>` as just `ALT TEXT`, with alternate font.
Would it be better to render it as, for example, `ALT TEXT [URL]`, so the information is not lost?


---

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:feature-requests] #72 rst2man: Show reference targets

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

checking with pandoc 

~~~
  See the `Python home page <https://www.python.org>`_ for info.
~~~

is converted to

~~~
  see See the Python home page (https://www.python.org) for info.
~~~

TODO

- how man pages will be broken if references are included
- modern web-references tend to be long ... a layout disaster so to say

should the link be

- in place
- end of paragraph
- in SEE ALSO

- what does mandoc do/show


---

**[feature-requests:#72] rst2man: Show reference targets**

**Status:** open
**Group:** Default
**Created:** Wed Aug 26, 2020 03:47 PM UTC by Petr Viktorin
**Last Updated:** Fri Apr 23, 2021 10:05 AM UTC
**Owner:** engelbert gruber


Currently, the manpage writer writes a reference like `ALT TEXT <URL>` as just `ALT TEXT`, with alternate font.
Would it be better to render it as, for example, `ALT TEXT [URL]`, so the information is not lost?


---

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:feature-requests] #29 include directive and parsed literals

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

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

The OP did not specify unambiguously what the desired behaviour would be and did not follow up for more than 10 years.
There has not been other requests for a "parsed-literal" include option.



---

**[feature-requests:#29] include directive and parsed literals**

**Status:** closed-invalid
**Group:** Default
**Created:** Fri Aug 31, 2012 06:49 PM UTC by Mike Solomon
**Last Updated:** Wed Mar 11, 2015 03:09 PM UTC
**Owner:** nobody


With Docutils >= 0.9, it is impossible to include HTML files \(without parsing of rst-inline-markup in the HTML file\) with the "include" directive::

.. include:: test.html
:code: HTML

It would be nice to have a new option for the include directive that allowed one to pass the content of the included file to a "parsed literal" block. Something like:

.. include:: test.html
:parsed-literal: HTML



---

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:feature-requests] #54 Allow unescaped white space in URI context

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

- **status**: open --> closed-rejected



---

**[feature-requests:#54] Allow unescaped white space in URI context**

**Status:** closed-rejected
**Group:** Default
**Created:** Mon Apr 03, 2017 01:40 AM UTC by Getreu
**Last Updated:** Wed Apr 05, 2017 04:51 PM UTC
**Owner:** nobody


David Goodger authored 2017-02-06 the following commit "Added support for escaped whitespace in URI contexts". Compared to the situation before where whitespace had to be % encoded this is huge improvement because it now allows the following:

```
.. image:: größeres\ Bild.jpg
```

I order to improve ergonomics more I suggest also allowing unescaped whitespace in URI context. This would follow the same syntax as `.. include` paths:

```
.. image:: größeres Bild.jpg

.. include:: schöne Einleitung.rst
```
*Besides ergonomics this proposal also improves consistancy.* 

The proposal arises from a discussion in this  [bug report 315](https://sourceforge.net/p/docutils/bugs/315/) where some concerns had ben expressed:

>  Bare (unescaped) spaces in URIs will not be supported in reST because they are inherently ambiguous.
> The fact that the "include" directive works with spaces in the path, without backslashes escaping the spacees, may just be an oversight, a happy accident. "include" is defined as requiring a filesystem path, whereas "image" requires a URI. We may revisit how "include" handles spaces in future.
> For consistency, we may eventually implement the following:
> `.. include:: path\ with\ spaces.txt`

I believe this is the wrong way to go: The unescaped version is the most ergonomic, it works well for a long time and imposing escaped whitespace would break exisiting inputs. For consistancy URI paths should allow whitespace too.


---

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:feature-requests] #70 Support for ToDo lists in ReStructured Text

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

- **status**: open --> closed-works-for-me



---

**[feature-requests:#70] Support for ToDo lists in ReStructured Text**

**Status:** closed-works-for-me
**Group:** Default
**Created:** Wed Aug 12, 2020 10:23 AM UTC by Ingo Keck
**Last Updated:** Wed May 17, 2023 06:47 AM UTC
**Owner:** nobody


Hi all,
Sorry if this has been brought up already, but I did not find anything here or in the mailing lists (though there are a lot hits for "todo" in links, so I may have missed it).

It would be great for using ReStructured Text for markup if it would also support lists with check-boxes like ToDo lists. The format could be like bullet lists, just using '[ ]' or '[x]' instead of '-', i.e.

[ ] first item not checked
[x] second item checked

I know that I can emulate this with a field list like 
:[ ]: first item not checked
but the semantic would be different, as field lists expect unique item names.

Could this be added or are there reasons to do it differently or not at all?

Background: I need a well defined, human readable markup language for everyday use and scientific publishing. ReStructured Text mostly fits the bill, but this is one of the things that always comes up in discussions.




---

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:feature-requests] #70 Support for ToDo lists in ReStructured Text

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

There are now a [FAQ entry](https://docutils.sourceforge.io/FAQ.html#how-can-i-mark-up-a-todo-list) and an [example](https://docutils.sourceforge.io/docs/user/todo-lists.html) for TODO lists with rST.


---

**[feature-requests:#70] Support for ToDo lists in ReStructured Text**

**Status:** open
**Group:** Default
**Created:** Wed Aug 12, 2020 10:23 AM UTC by Ingo Keck
**Last Updated:** Sat Mar 27, 2021 04:45 PM UTC
**Owner:** nobody


Hi all,
Sorry if this has been brought up already, but I did not find anything here or in the mailing lists (though there are a lot hits for "todo" in links, so I may have missed it).

It would be great for using ReStructured Text for markup if it would also support lists with check-boxes like ToDo lists. The format could be like bullet lists, just using '[ ]' or '[x]' instead of '-', i.e.

[ ] first item not checked
[x] second item checked

I know that I can emulate this with a field list like 
:[ ]: first item not checked
but the semantic would be different, as field lists expect unique item names.

Could this be added or are there reasons to do it differently or not at all?

Background: I need a well defined, human readable markup language for everyday use and scientific publishing. ReStructured Text mostly fits the bill, but this is one of the things that always comes up in discussions.




---

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:feature-requests] #95 License "Python 2.1.1" doesn't exist as an SPDX identifier

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

The "roman" package is a 3rd party module that exists independent of Docutils.
(Included in Docutils as a convenience to simplify installation in the old days we did not have `pip`'s dependency handling.)

Fedora may follow the Debian example and remove "roman.py" from the distribution's Docutils package, adding a dependency on the [python-roman](https://koji.fedoraproject.org/koji/packageinfo?packageID=19352) package instead.

The "roman.py" Python module is actively maintained at  https://github.com/zopefoundation/roman. The license stated in its official release at pypi is also the "Python 2.1.1 license".
To keep the burden of the "roman.py" maintainers and the original author small, I suggest that the licensing issue is raised (and hopefully settled) with them by fedora (as it not only affects Docutils).

We will happily change the license information in Docutils if the upstream roman.py release provides an SPDX-compatible license option.









---

**[feature-requests:#95] License "Python 2.1.1" doesn't exist as an SPDX identifier**

**Status:** open
**Group:** Default
**Created:** Mon May 15, 2023 08:37 AM UTC by Karolina Surma
**Last Updated:** Mon May 15, 2023 08:37 AM UTC
**Owner:** nobody


Hello,
in an effort to declare the licenses according to the SPDX standards we're now going through in Fedora Linux, we've come across an issue with the Python 2.1.1 license - there's no such SPDX identifier.
The license is declared in the COPYING file and the text is additionally shipped with the software.
https://sourceforge.net/p/docutils/code/HEAD/tree/tags/docutils-0.20/COPYING.txt#l131

I asked the [Fedora Legal Team]( https://gitlab.com/fedora/legal/fedora-license-data/-/issues/216#note_1387584572) how to proceed, an the answer was:

> What Mark Pilgrim actually said in Dive Into Python:
"The example programs in this book are free software; you can redistribute and/or modify them under the terms of the Python license as published by the Python Software Foundation. A copy of the license is included in Appendix H, Python license."
I am tempted to say that we should interpret this as meaning that it is just the PSF license that he intended to cover the example code (with some implied customization as to licensor and software), despite the fact that Appendix H includes a copy of a variant of the CPython stack license (faithfully reproduced by the docutils project).
If I were involved in the docutils project, I would suggest they replace the Python 2.1.1 license text with some sort of instantiation of the PSF-2.0 license text, and possibly attempt to get in touch with Mark Pilgrim to confirm that this is appropriate.

Would it be possible to do so?


---

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] #471 0.20 fails tests on pypy3

[Michał G. <mgo...@us...>]

Thanks. I can confirm that this version works for us.


---

**[bugs:#471] 0.20 fails tests on pypy3**

**Status:** closed-fixed
**Created:** Wed May 10, 2023 02:53 AM UTC by Michał Górny
**Last Updated:** Wed May 17, 2023 06:11 AM UTC
**Owner:** nobody


When running the test suite of the 0.20 release on PyPy3, I get the following test failure:

```
Testing Docutils 0.20 with Python 3.9.16 on 2023-05-10 at 04:44:04
OS: Linux 6.2.14-gentoo-dist #1 SMP PREEMPT_DYNAMIC Mon May  1 15:03:02 -00 2023 (linux, Linux-6.2.14-gentoo-dist-x86_64-AMD_Ryzen_5_3600_6-Core_Processor-with-glibc2.37)
Working directory: /tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/test
Docutils package: /tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/docutils
.....................................................................s................................................................................................................................................................................................................s..............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................E.............................................
======================================================================
FAIL: test_embed_embed_stylesheet (test_writers.test_latex2e.WriterPublishTestCase) (id="samples_embed_stylesheet['two-styles'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/test/test_writers/test_latex2e.py", line 151, in test_embed_embed_stylesheet
    self.assertEqual(output, expected)
AssertionError: "\\do[452 chars]ory: PosixPath('data/spam.sty')\n% embedded st[439 chars]t}\n" != "\\do[452 chars]ory: 'data/spam.sty'\n% embedded stylesheet: d[428 chars]t}\n"
  \documentclass[a4paper]{article}
  % generated by Docutils <https://docutils.sourceforge.io/>
  \usepackage{cmap} % fix search and cut-and-paste in Acrobat
  \usepackage{ifthen}
  \usepackage[T1]{fontenc}
  
  %%% Custom LaTeX preamble
  % PDF Standard Fonts
  \usepackage{mathptmx} % Times
  \usepackage[scaled=.90]{helvet}
  \usepackage{courier}
  
  %%% User specified packages and stylesheets
  % Cannot embed stylesheet:
- %  [Errno 2] No such file or directory: PosixPath('data/spam.sty')
?                                         ----------               -
+ %  [Errno 2] No such file or directory: 'data/spam.sty'
  % embedded stylesheet: data/ham.tex
  \newcommand{\ham}{wonderful ham}
  
  
  %%% Fallback definitions for Docutils-specific commands
  
  % hyperlinks:
  \ifthenelse{\isundefined{\hypersetup}}{
    \usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
    \usepackage{bookmark}
    \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
  }{}
  
  %%% Body
  \begin{document}
  
  two stylesheets embedded in the header
  
  \end{document}


----------------------------------------------------------------------
Ran 1636 tests in 14.868s

FAILED (failures=1, skipped=2)
Elapsed time: 15.745 seconds
```


---

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] #471 0.20 fails tests on pypy3

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

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

Fixed in [Docutils 0.20.1](https://pypi.org/project/docutils/0.20.1).
Thank you for reporting.



---

**[bugs:#471] 0.20 fails tests on pypy3**

**Status:** closed-fixed
**Created:** Wed May 10, 2023 02:53 AM UTC by Michał Górny
**Last Updated:** Thu May 11, 2023 03:56 PM UTC
**Owner:** nobody


When running the test suite of the 0.20 release on PyPy3, I get the following test failure:

```
Testing Docutils 0.20 with Python 3.9.16 on 2023-05-10 at 04:44:04
OS: Linux 6.2.14-gentoo-dist #1 SMP PREEMPT_DYNAMIC Mon May  1 15:03:02 -00 2023 (linux, Linux-6.2.14-gentoo-dist-x86_64-AMD_Ryzen_5_3600_6-Core_Processor-with-glibc2.37)
Working directory: /tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/test
Docutils package: /tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/docutils
.....................................................................s................................................................................................................................................................................................................s..............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................E.............................................
======================================================================
FAIL: test_embed_embed_stylesheet (test_writers.test_latex2e.WriterPublishTestCase) (id="samples_embed_stylesheet['two-styles'][0]")
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/tmp/portage/dev-python/docutils-0.20/work/docutils-0.20/test/test_writers/test_latex2e.py", line 151, in test_embed_embed_stylesheet
    self.assertEqual(output, expected)
AssertionError: "\\do[452 chars]ory: PosixPath('data/spam.sty')\n% embedded st[439 chars]t}\n" != "\\do[452 chars]ory: 'data/spam.sty'\n% embedded stylesheet: d[428 chars]t}\n"
  \documentclass[a4paper]{article}
  % generated by Docutils <https://docutils.sourceforge.io/>
  \usepackage{cmap} % fix search and cut-and-paste in Acrobat
  \usepackage{ifthen}
  \usepackage[T1]{fontenc}
  
  %%% Custom LaTeX preamble
  % PDF Standard Fonts
  \usepackage{mathptmx} % Times
  \usepackage[scaled=.90]{helvet}
  \usepackage{courier}
  
  %%% User specified packages and stylesheets
  % Cannot embed stylesheet:
- %  [Errno 2] No such file or directory: PosixPath('data/spam.sty')
?                                         ----------               -
+ %  [Errno 2] No such file or directory: 'data/spam.sty'
  % embedded stylesheet: data/ham.tex
  \newcommand{\ham}{wonderful ham}
  
  
  %%% Fallback definitions for Docutils-specific commands
  
  % hyperlinks:
  \ifthenelse{\isundefined{\hypersetup}}{
    \usepackage[colorlinks=true,linkcolor=blue,urlcolor=blue]{hyperref}
    \usepackage{bookmark}
    \urlstyle{same} % normal text font (alternatives: tt, rm, sf)
  }{}
  
  %%% Body
  \begin{document}
  
  two stylesheets embedded in the header
  
  \end{document}


----------------------------------------------------------------------
Ran 1636 tests in 14.868s

FAILED (failures=1, skipped=2)
Elapsed time: 15.745 seconds
```


---

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] #467 sdist is missing tox.ini

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

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

Fixed in [Docutils 0.20.1](https://pypi.org/project/docutils/0.20.1).
Thank you for reporting.



---

**[bugs:#467] sdist is missing tox.ini**

**Status:** closed-fixed
**Created:** Thu Feb 23, 2023 12:48 PM UTC by Marcel Telka
**Last Updated:** Wed May 10, 2023 10:24 AM UTC
**Owner:** nobody


The sdist package at PyPI is missing tox.ini file.  Please add the file to sdist to make downstream testing easier.  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:bugs] #461 docutils sdist contains html files in egg-info

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

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

Fixed in [Docutils 0.20.1](https://pypi.org/project/docutils/0.20.1).
Thanks for the report.



---

**[bugs:#461] docutils sdist contains html files in egg-info**

**Status:** closed-fixed
**Created:** Wed Nov 16, 2022 02:40 PM UTC by Karolina Surma
**Last Updated:** Wed May 10, 2023 10:25 AM UTC
**Owner:** nobody


When packaging docutils 0.19 in Fedora, we realized there are HTML files in the distribution's egg-info (next to the txt "original" ones) which make their way to the wheel too.
```
dependency_links.html
SOURCES.html
top_level.html
```

It looks like something, possibly `tools/buildhtml.py`, makes a batch conversion of the txt files in the project. It should probably ignore the egg-info directory when run.


---

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 release 0.20.1 on pip and sourceforge

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

Hei 0.20.1 is out

a small bug fix release


* docutils/MANIFEST.in

  - Include tox.ini and docutils.conf in the source package
    (cf. bug #467 and bug #461).

* tools/rst2odt_prepstyles.py

  - Moved to ``docutils/writers/odf_odt/prepstyles.py``.
    Replaced with a provisional backwards compatibility script.

* no developer files from my local system, no html-files in the
egg-directory

cheers
 e