docutils-develop — For developer discussions of the implementation.

[Docutils-develop] [docutils:patches] #122 Support Custom Meta in odf_odt writer

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

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

Applied in Docutils 0.18. Thanks again for the patch.
There is a TODO item left, as File>Properties>Description also provides a "subject" field.



---

** [patches:#122] Support Custom Meta in odf_odt writer**

**Status:** pending-remind
**Group:** None
**Created:** Wed Feb 04, 2015 06:50 PM UTC by pifi
**Last Updated:** Fri Jan 08, 2021 11:38 PM UTC
**Owner:** nobody
**Attachments:**

- [docutils_custom_meta_odt_patches.tar.gz](https://sourceforge.net/p/docutils/patches/122/attachment/docutils_custom_meta_odt_patches.tar.gz) (33.8 kB; application/gzip)


This patch enhanced the ..meta directive in odt writer. Generic fields (anything except 'keywords' and 'description') are treated as Custom Properties in odt.

The archive contains 2 patches:

+ 'custom_meta_odt_doc.diff': patch on the documentation.
+ 'custom_meta_odt.diff': patch on the odf_odt writer code.

The archive also contains the 2 modified files.


---

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] #177 Arabic Translation

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

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

Applied in Docutils 0.18.
Thanks again for the patch.
(Is there still hope for a documentation patch?)



---

** [patches:#177] Arabic Translation**

**Status:** closed-accepted
**Group:** None
**Created:** Wed Dec 23, 2020 07:45 PM UTC by Abdullah
**Last Updated:** Wed May 26, 2021 09:24 PM UTC
**Owner:** nobody
**Attachments:**

- [Ar.py](https://sourceforge.net/p/docutils/patches/177/attachment/Ar.py) (2.0 kB; text/plain)
- [Ar_parser.py](https://sourceforge.net/p/docutils/patches/177/attachment/Ar_parser.py) (3.4 kB; text/plain)


I have translated docutils library and ReStructuredText parser to Aarabic. The translated files are attached. 




---

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] #181 LaTeX writer: Fix tocdepth when chapter/part in use

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

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

Applied in Docutils 0.18.
Thanks again for the patch



---

** [patches:#181] LaTeX writer: Fix tocdepth when chapter/part in use**

**Status:** closed-accepted
**Group:** None
**Created:** Sun Jun 06, 2021 05:23 PM UTC by John Thorvald Wodder II
**Last Updated:** Thu Jun 17, 2021 07:26 PM UTC
**Owner:** nobody
**Attachments:**

- [tocdepth.patch](https://sourceforge.net/p/docutils/patches/181/attachment/tocdepth.patch) (3.7 kB; application/octet-stream)


Currently, when Docutils converts a document containing `.. contents:: :depth: N` to LaTeX, the user-supplied depth value is used as-is.  This works fine when the only sectioning commands in the resulting document are `\section` and its subdivisions, but when the documentclass uses chapters or `use_part_section` is in effect, this gives the wrong result.  For example, a depth of 1 means to only show the topmost sectioning level in the TOC; when that level is "chapter", the `tocdepth` counter should be set to 0, and when it is "part", the counter should be set to either -1 (if the document class uses chapters) or 0 (if it does not).

The attached patch corrects the calculation of `tocdepth` using basically the same code that is already in use for calculating `secnumdepth`.


---

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] #184 Fix a typo in latex2e

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

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

Applied in Docutils 0.18.
Thanks again for the patch



---

** [patches:#184] Fix a typo in latex2e**

**Status:** closed-accepted
**Group:** None
**Created:** Fri Aug 20, 2021 02:54 AM UTC by Clément Pit-Claudel
**Last Updated:** Sat Sep 11, 2021 12:33 PM UTC
**Owner:** nobody
**Attachments:**

- [1-latex-typo.patch](https://sourceforge.net/p/docutils/patches/184/attachment/1-latex-typo.patch) (681 Bytes; text/x-patch)


Please let me know if the patch is in the right format (I haven't used SVN in ages)


---

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] #28 Allows easy referencing of section titles

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

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

Implemented in Docutils 0.18.
Thank you for the suggestion.



---

** [feature-requests:#28] Allows easy referencing of section titles**

**Status:** closed-fixed
**Group:** Default
**Created:** Mon Nov 28, 2011 02:44 PM UTC by 
**Last Updated:** Mon Jul 05, 2021 07:51 PM UTC
**Owner:** nobody


In rst2html, you have three choices regarding to generating toc backlinks:

\--no-toc-backlinks
\--top-toc-backlinks
\--toc-entry-backlinks

However I would like each section title to have a link to itself, or at least
some anchor that allows to have the link to the current section, regardless
whether there's a toc in the document or not.

This is very handy when referencing online documents. Sphinx does something similar by using an on-hover pilcrow:

http://docs.python.org/reference/compound\_stmts.html\#the-for-statement

after each section title, there's pilcrow \(on hover\) linking to the current 
section.

See the discussion at:

http://thread.gmane.org/gmane.text.docutils.user/6517

<<Use case:

I often need a reference to a section in the docs when answering a question
here or at the Sphinx list. Then, usually I open the HTML version of the
doc, check the content and copy the link from there.

a\) With a toc and --toc-entry-backlinks \(or a small toc and
\--top-toc-backlinks\), it is straightforward to

\* click at the section heading -> brings you to the toc,
\* right-click at the toc entry and select "copy link address",
\* paste the link in the editor.

Example:
http://docutils.sourceforge.net/docs/dev/todo.html\#epub-html-writer

b\) Without a toc or with --no-toc-backlinks, this work-flow does not work:

\* no "copyable link" in the document without a toc
\* "copyable link" in the toc not easy to find when reading the section with
\--no-toc-backlinks.

So, while I don't like Sphinx's "pop-up" pilcrows, I see their use in case
b\) \(and for other referencable objects\).

You could file a feature request at the tracker
http://sourceforge.net/tracker/?group\_id=38414&atid=422033


Alternatively, we could offer a new option for the \`toc\_backlinks\` setting:

Enable backlinks from section titles to 

\* table of contents entries \("entry"\), 
\* to the top of the TOC \("top"\), 
\* to themselves \("self"\),
\* or disable \("none"\).

together with a --self-backlinks command line option.

Then, with toc\_backlinks == "self", right-click on a section title would
allow to copy the sections URL.>>

That's exactly my use case as well: I generate online documents with rst2html all the time, and whenever I need to reference to a document I usually do link to the relevant section.

I was already aware of the "entry" option \(to toc, then get the url\), but that's rather inconvenient, and as you say it doesn't work whenever the toc is missing.

I'm personally fine with either the Sphinx solution \("on-hover pilcrow", which would be easy enough to customize via css\) or via the "self" behavior \(which I like much more at the moment. Admittedly I have never used the back-to-toc feature of the section titles, I would instead certainly use the direct link without further fuss\).


---

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] #73 Support <details> and <summary> HTML5 elements

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

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

Implemented in r8853.



---

** [feature-requests:#73] Support <details> and  <summary> HTML5 elements**

**Status:** closed-fixed
**Group:** Default
**Created:** Fri Sep 11, 2020 11:18 AM UTC by Günter Milde
**Last Updated:** Mon Jul 05, 2021 10:36 AM UTC
**Owner:** nobody


Alan G. Isaac suggested support for the <details> and  <summary>  elements in the HTML5 writer.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details

Idea: work similar to the recent additions for
"semantic styling", i.e. a description list with matching class value
would be mapped to a "details" element::

    .. class:: details

    Summary
        The details should
        go here.




---

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] #78 Support lazy loading for image and figure

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

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

Implemented in Docutils 0.18.
Thanks again for the suggestion.



---

** [feature-requests:#78] Support lazy loading for image and figure**

**Status:** closed-fixed
**Group:** Default
**Created:** Sun Mar 28, 2021 10:40 PM UTC by Tim Hoffmann
**Last Updated:** Wed Oct 13, 2021 03:44 PM UTC
**Owner:** nobody


Lazy loading can be achieved by adding a `loading` attribute to the `<img>` tag in HTML `<img ... loading="lazy">`.

https://html.spec.whatwg.org/multipage/urls-and-fetching.html#lazy-loading-attributes

The ReST code should probably look like this:
~~~
.. image:: test.png
   :loading: lazy
~~~
and 
~~~
.. figure:: test.png
   :loading: lazy
~~~



---

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

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

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

Fixed in r8871. Thank you for the report.



---

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

**Status:** open-fixed
**Created:** Fri Oct 29, 2021 09:44 PM UTC by Eric Hellman
**Last Updated:** Fri Oct 29, 2021 09:44 PM UTC
**Owner:** nobody


in 

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

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

should be 

`font-style: oblique;`



---

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

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

[Docutils-develop] [docutils:bugs] #169 Non-free license of IE PNG Fix

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

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

Fixed in Docutils 0.18.



---

** [bugs:#169] Non-free license of IE PNG Fix**

**Status:** closed-fixed
**Labels:** S5 writer 
**Created:** Sun Aug 21, 2011 10:02 PM UTC by U
**Last Updated:** Tue May 18, 2021 09:35 PM UTC
**Owner:** nobody


iepngfix.htc has the following licene:

// Free usage permitted as long as this notice remains intact.

This is not a free license \(for one thing, it doesn't permit modifications\) and certainly not GPL-compatible. You might want to upgrade your copy of IE PNG Fix, as the current version is available under the LGPL 2.1 \(or later\) license.



---

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] #241 doctree-based publishing != publish_string

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

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

Fixed in Docutils 0.18. Thanks again for the report.



---

** [bugs:#241] doctree-based publishing != publish_string**

**Status:** closed-fixed
**Created:** Thu Sep 19, 2013 04:36 PM UTC by metagriffin
**Last Updated:** Thu Jun 17, 2021 02:35 PM UTC
**Owner:** nobody


i would expect a call to publish_string() and publish_doctree() + publish_from_doctree() with exactly the same arguments to result in identical output, but this is not the case. sample program to illustrate the issue:

    :::python
    from docutils.core import *

    rst = '''\
    My Document
    ===========

    .. meta::
      :my-custom-header: my-custom-value
    '''

    settings = {
      'output_encoding': 'UTF-8',
      'stylesheet_path': None,
      }

    sOut  = publish_string(rst, writer_name='html', settings_overrides=settings)
    dtree = publish_doctree(rst)
    dOut  = publish_from_doctree(dtree, writer_name='html', settings_overrides=settings)

    # this assert passes
    assert '<meta content="my-custom-value" name="my-custom-header" />' in sOut

    # these asserts fail
    assert '<meta content="my-custom-value" name="my-custom-header" />' in dOut
    assert sOut == dOut

note that besides the `meta` directive missing in the doctree version, everything else looks the same.


---

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] #244 Wrong subscript/superscript order with `rst2html --math-output=HTML`

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

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

Fixed in Docutils 0.18. Thanks again for the report.



---

** [bugs:#244] Wrong subscript/superscript order with `rst2html --math-output=HTML`**

**Status:** closed-fixed
**Labels:** math html 
**Created:** Thu Nov 21, 2013 07:34 AM UTC by spider-mario
**Last Updated:** Sun May 02, 2021 09:29 PM UTC
**Owner:** nobody
**Attachments:**

- [sup-sub-order.html](https://sourceforge.net/p/docutils/bugs/244/attachment/sup-sub-order.html) (13.1 kB; text/html)
- [sup-sub-order.rst](https://sourceforge.net/p/docutils/bugs/244/attachment/sup-sub-order.rst) (130 Bytes; application/octet-stream)


In math mode, when there are both a subscript and a superscript, the `^` and `_` symbols are not taken into account by the HTML writer to decide which is which: only their order matters, as illustrated by the attached file.

Environment in which the problem was encountered:
- Operating system: Arch Linux
- Python version: 3.3.2
- Docutils version: 0.11


---

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] #407 Inline MathML role and block MathML directive appear with reversed styles

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

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

Fixed in Docutils 0.18. Thanks again for the report.



---

** [bugs:#407] Inline MathML role and block MathML directive appear with reversed styles**

**Status:** closed-fixed
**Created:** Tue Oct 13, 2020 11:21 AM UTC by ManDay
**Last Updated:** Fri May 21, 2021 12:50 PM UTC
**Owner:** nobody
**Attachments:**

- [test.rst](https://sourceforge.net/p/docutils/bugs/407/attachment/test.rst) (302 Bytes; text/x-rst)


`:math:` produces large parentheses which seem to disrupt text layout more than necessary while `.. math::` produces small parentheses which affect the math rendering without any apparent need. The behaviour of large vs. small parentheses should be reversed.

I'm not sure how far the presentation is specified, but the behaviour is consistently observed in Firefox and WebkitGtk, I therefore think docutils could reverse the style, unless there is an inherent disagreement between other browsers.


---

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] #421 Typo in r8766: optional = (meta) instead of optional = (meta, )

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

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

Fixed in Docutils 0.18. Thanks again for the report.



---

** [bugs:#421] Typo in r8766: optional = (meta) instead of optional = (meta,) **

**Status:** closed-fixed
**Created:** Thu Jul 08, 2021 11:10 PM UTC by Clément Pit-Claudel
**Last Updated:** Thu Jul 29, 2021 03:03 AM UTC
**Owner:** nobody


Revision r8766 has a typo: it changes the `optional` field of `nodes.NodeVisitor` from `()` to `(meta)` in `nodes.py`; it should be `(meta,)` instead, as the current code breaks the check `node.__class__.__name__ not in self.optional` in function `unknown_visit`.


---

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] #422 Improving table width calculations in LaTeX export

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

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

Fixed in Docutils 0.18. Thanks again for report and analysis.



---

** [bugs:#422] Improving table width calculations in LaTeX export**

**Status:** closed-fixed
**Created:** Thu Jul 29, 2021 03:14 AM UTC by Clément Pit-Claudel
**Last Updated:** Thu Sep 30, 2021 02:22 PM UTC
**Owner:** nobody


Table widths are approximate when generating LaTeX, and this causes overfull hbox warnings, with tables bleeding into the margins.  For example:

    .. list-table::

       -
         * 1
         * 2
       -
         * A
         * B

This generates the following LaTeX:

```latex
\setlength{\DUtablewidth}{\linewidth}
\begin{longtable*}[c]{|p{0.470\DUtablewidth}|p{0.470\DUtablewidth}|}
\hline

1
 & 
2
 \\
\hline

A
 & 
B
 \\
\hline
\end{longtable*}
```

This produces this warning:

```
Overfull \hbox (4.50082pt too wide) in alignment at lines 32--46
 [] [] 
```

The docstring of `get_colspecs` says  "Table width is hairy.", which is true, but things can be improved.  The problem is `\setlength{\DUtablewidth}{\linewidth}`, which doesn't account for the space between columns and the thickness of the vertical rules.  The correct calculation in this case is:

```
\setlength{\DUtablewidth}{\dimexpr\linewidth-4\tabcolsep-3\arrayrulewidth\relax}
```

Which means:

```
\setlength{\DUtablewidth}
  {\dimexpr% Start a calculation
   \linewidth% Start with the user-requested width
   -4\tabcolsep% Subtract the column padding: one on each side of central dividers + one on right of leftmost divider + one on left or rightmost divider
   -3\arrayrulewidth%subtract the width of the dividers ("rules")
   \relax% Finish the calculation
  }
```

The general formula is `<requested width> - <2 * ncols> * \tabcolsep - <ncols + 1> * \arrayrulewidth`

And in fact with that formula most of the "wiggling room" in the implementation can be removed.


---

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] #423 Code blocks in sidebars cause LaTeX errors

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

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

Fixed in Docutils 0.18. Thanks again for the report.



---

** [bugs:#423] Code blocks in sidebars cause LaTeX errors**

**Status:** closed-fixed
**Created:** Mon Aug 23, 2021 02:06 AM UTC by Clément Pit-Claudel
**Last Updated:** Tue Sep 07, 2021 09:07 PM UTC
**Owner:** nobody


Docutils uses `alltt` in LaTeX for code blocks, so that this input:

~~~
::

   Test_1234
~~~

becomes this output:

~~~
\begin{quote}
\begin{alltt}
Test_1234
\end{alltt}
\end{quote}
~~~

Unfortunately, this doesn't work in all cases.  This:

~~~
.. sidebar:: asd

   ::

      Test_1234
~~~

becomes this:

~~~
\DUsidebar{
\DUtitle[sidebar]{asd}

\begin{quote}
\begin{alltt}
Test_1234
\end{alltt}
\end{quote}
}
~~~

Which causes a LaTeX error because of the `_` character:

~~~
./test.tex:66: Missing $ inserted.
<inserted text>
                $
l.66 }


./test.tex:66: LaTeX Error: Command \end{alltt} invalid in math mode.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.66 }

./test.tex:66: Missing $ inserted.
<inserted text>
                $
l.66 }
~~~

The problem is that it's not safe to use `alltt` in a macro argument, because it doesn't get to change the catcode of `_`.  The solution would be either to make DUsidebar an environment instead of a macro, or to escape the contents of `alltt`.


---

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] #424 Wrong circular inclusion detection

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

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

Fixed in Docutils 0.18.



---

** [bugs:#424] Wrong circular inclusion detection**

**Status:** closed-fixed
**Created:** Fri Sep 10, 2021 08:39 AM UTC by Yangsu Kim
**Last Updated:** Tue Oct 12, 2021 05:37 PM UTC
**Owner:** nobody


Following warning is displayed with inclusion failure when parsing body.rst
> body.rst:34: Warning: circular inclusion in "include" directive: gap.rst < gap.rst < body.rst

It is tesed on 0.17.1. I suspect wrong self.lineno from the 4th include due to short distance from the 3rd include.

body.rst
~~~
.. _my_table:
.. table:: a
   :class: longtable
   :widths: 100

   +----------------------+
   | a                    |
   +======================+
   | a                    |
   |                      |
   | .. include:: gap.rst |
   |                      |
   | a                    |
   +----------------------+
   | a                    |
   |                      |
   | .. include:: gap.rst |
   |                      |
   | a                    |
   +----------------------+
   | a                    |
   |                      |
   | .. include:: gap.rst |
   |                      |
   | a                    |
   |                      |
   | .. include:: gap.rst |
   |                      |
   | a                    |
   +----------------------+
   | a                    |
   |                      |
   | .. include:: gap.rst |
   |                      |
   | a                    |
   +----------------------+
~~~

gap.rst
~~~
.. raw:: latex

   \vspace{2mm}
~~~


---

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] #425 Node ID will be lost when a `--language` option given.

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

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

Fixed in Docutils 0.18.



---

** [bugs:#425] Node ID will be lost when a `--language` option given.**

**Status:** closed-fixed
**Created:** Sun Sep 19, 2021 06:15 AM UTC by Takeshi KOMIYA
**Last Updated:** Mon Sep 20, 2021 03:23 PM UTC
**Owner:** nobody


This is a reproducible example:

```
A test document to check the behavior of docutils.

.. _table1:
.. list-table:: Table with hyperlink target

   * - header

.. list-table:: Table with name
   :name: table2

   * - header

A reference to `table1`_ will not work because generated HTML does not contain `#table1` element if `--language` option is set to non-English.
A reference to `table2`_ will work even if any `--language` option given.
```

When I run docutils via `rst2html.py test.rst -l zh_cn` command, the `table1` ID will be lost in the HTML output. Internally, docutils generates a system_message node having the node ID and suppress it on conversion.

```
<system_message ids="t2-1" level="1" line="11" names="t2-1" source="/spinx-error/source/02-安装.rst" type="INFO"><paragraph>No directive entry for “list-table” in module “docutils.parsers.rst.languages.zh_cn”.
Using English fallback for directive “list-table”.</paragraph></system_message>
```

The system_message was generated because `docutils.parsers.rst.languages.zh_cn.directives` does not have a key named `list-table`.

I think the INFO message is not needed if fallback to English succeeded.


---

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] #426 strange behavior when table meets CJK character

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

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

Fixed in Docutils 0.18.



---

** [bugs:#426] strange behavior when table meets CJK character**

**Status:** closed-fixed
**Created:** Sun Sep 26, 2021 01:11 PM UTC by chenxu
**Last Updated:** Fri Oct 01, 2021 01:42 PM UTC
**Owner:** nobody
**Attachments:**

- [test.txt](https://sourceforge.net/p/docutils/bugs/426/attachment/test.txt) (246 Bytes; text/plain)


sometimes the last character always in a new line alone, like these:

![QQ截图20210926210719.png](https://i.loli.net/2021/09/26/buim3Ja8w2x7jps.png)

tested on snapshot, seems `width` is not correct, `55%` `45%` is better

```html
<table border="1" class="docutils">
<colgroup>
<col width="56%" />
<col width="44%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">返回值类型</th>
<th class="head">解释</th>
</tr>
</thead>
<tbody valign="top">
<tr><td>nil</td>
<td>无返回值</td>
</tr>
</tbody>
</table>
```

test:

```cmd
python rst2html.py test.txt test.html
```






---

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

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

Re: [Docutils-develop] docutils option list not following rST Spec

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

On 2021-10-25, Mickey Endito via Docutils-develop wrote:

> During testing I stumbled upon a spec mismatch by docutils.

> From the reStructuredText Specification_ (emphasis mine)

>    Either a **space** or an **equals** sign may be used as a delimiter between
>    options and option argument placeholders; short options ("-" or "+" prefix
>    only) **may omit** the delimiter.

> However, using ``=`` in short options does not work::
...
> and everything from ``-a=foo`` is read as a paragraph.

Fixed in r8872.

Thank you for the report,

Günter

[Docutils-develop] [docutils:bugs] Re: #431 docutils 0.18 - Error when using Sphinx package

[Lital Y. <lit...@us...>]

Thank you for checking this.


Lital Yair | Software Team Leader | Life Science Group
Bio-Rad Israel Ltd | Netiv Haor 1, Haifa, Israel 3508510
Office +972 4 8123103  | Direct +972 4 6606612  | Mobile +972 52 4410017

[https://ci3.googleusercontent.com/proxy/Zkk8mJPkV9mPmozwUqeSQMbtXuU_AZNFLS--8ROA6-kUvQ-qUfnuTj4rNZ735jGVXwZEgRVCAm8EEDGCf1a9HvC_spRbbavv1hd6UIsuZtu-otKv7KW3J1UZAodmrJ5S-yFbM-cIPleQasD4cHO_glazNJ-tWWbe45ZuAMAu4R_CgKDN9kjgaqdW0-muVRwJtEBizLKMFFvTImryTQ=s0-d-e1-ft#https://docs.google.com/uc?export=download&id=1BzQSPwumddncys880hG40_EiWW9kVewg&revid=0B94Tx6wSJcdST0VpWXNRMGVGSFJrYy9hQmFnVUdQOGZaelE0PQ]
________________________________
From: "G?nter Milde" <mi...@us...>
Sent: Sunday, October 31, 2021 12:46 AM
To: [docutils:bugs] <43...@bu...>
Subject: [docutils:bugs] #431 docutils 0.18 - Error when using Sphinx package


[EXTERNAL]: Do not click links or open attachments unless you recognize the sender

Current versions of Sphinx have pin the Docutils dependency to tested versions
(Sphinx-3.5.4 depends on docutils < 0.17, versions since Sphinx 4.1 depend on docutils < 0.18).

Users of older Sphinx versions or should add similar pins. Also users with non-standard Sphinx extensions may need to add an explicit dependency.

I recommend pinning to <0.18 instead of ==0.17. This allows bugfix releases like 0.17.1.

________________________________

[bugs:#431]<https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsourceforge.net%2Fp%2Fdocutils%2Fbugs%2F431%2F&data=04%7C01%7Clital_yair%40bio-rad.com%7C10cce62c48d148aad7f508d99beeb4e2%7Cef0aebeb2af047a3b8ae5665f8a62d11%7C0%7C0%7C637712272562690484%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=EO8dIvQmM2f5ZvxODPFoCGS%2F1nJV9Du5offtdgQBuMQ%3D&reserved=0> docutils 0.18 - Error when using Sphinx package

Status: open
Created: Wed Oct 27, 2021 09:47 AM UTC by Lital Yair
Last Updated: Thu Oct 28, 2021 07:24 AM UTC
Owner: nobody

Hi All

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

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

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

Any help will be much appreciated.
Thanks, Lital

________________________________

Sent from sourceforge.net because you indicated interest in https://sourceforge.net/p/docutils/bugs/431/<https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsourceforge.net%2Fp%2Fdocutils%2Fbugs%2F431%2F&data=04%7C01%7Clital_yair%40bio-rad.com%7C10cce62c48d148aad7f508d99beeb4e2%7Cef0aebeb2af047a3b8ae5665f8a62d11%7C0%7C0%7C637712272562700445%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=50mN%2FoEi3PrSEdM%2Fj033uquAjfpM%2Bo3DkBNOXWvkwl0%3D&reserved=0>

To unsubscribe from further messages, please visit https://sourceforge.net/auth/subscriptions/<https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fsourceforge.net%2Fauth%2Fsubscriptions%2F&data=04%7C01%7Clital_yair%40bio-rad.com%7C10cce62c48d148aad7f508d99beeb4e2%7Cef0aebeb2af047a3b8ae5665f8a62d11%7C0%7C0%7C637712272562700445%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&sdata=EylHNhwCQWnq4Oc08Dglg5DPFm0ao6u1VYIfZdDCZZc%3D&reserved=0>



---

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

**Status:** pending-out-of-date
**Created:** Wed Oct 27, 2021 09:47 AM UTC by Lital Yair
**Last Updated:** Sat Oct 30, 2021 09:47 PM UTC
**Owner:** nobody


Hi All

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

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

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

Any help will be much appreciated.
Thanks, Lital


---

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

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

[Docutils-develop] [docutils:bugs] #431 docutils 0.18 - Error when using Sphinx package

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

- **status**: open --> pending-out-of-date
- **Comment**:

This dependendy problem should be solved with up-to-date versions of Sphinx.



---

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

**Status:** pending-out-of-date
**Created:** Wed Oct 27, 2021 09:47 AM UTC by Lital Yair
**Last Updated:** Sat Oct 30, 2021 09:46 PM UTC
**Owner:** nobody


Hi All

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

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

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

Any help will be much appreciated.
Thanks, Lital


---

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

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

[Docutils-develop] [docutils:bugs] #431 docutils 0.18 - Error when using Sphinx package

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

Current versions of Sphinx have pin the Docutils dependency to tested versions
(Sphinx-3.5.4 depends on docutils < 0.17,  versions since Sphinx 4.1 depend on docutils < 0.18).

Users of older Sphinx versions or should add similar pins. Also users with non-standard Sphinx extensions may need to add an explicit dependency.

I recommend pinning to <0.18 instead of ==0.17. This allows bugfix releases like 0.17.1.


---

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

**Status:** open
**Created:** Wed Oct 27, 2021 09:47 AM UTC by Lital Yair
**Last Updated:** Thu Oct 28, 2021 07:24 AM UTC
**Owner:** nobody


Hi All

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

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

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

Any help will be much appreciated.
Thanks, Lital


---

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

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

Re: [Docutils-develop] Possible bug in docutils verison 0.18.0

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

On 2021-10-28, Peter Liu wrote:

> I'm getting an import error when trying to import html from
> docutils.parsers.rst.directives on this version of docutils:

> ImportError: cannot import name 'html' from
> 'docutils.parsers.rst.directives'

> After reverting back to docutils 0.17.1, the import works fine. Is this
> a possible bug?

This is the side effect of an intended change. It is documented in the
HISTORY:

  * docutils/parsers/rst/directives/html.py
  
    - Removed. (Meta directive moved to ``misc.py``.)
  
  * docutils/parsers/rst/directives/misc.py
  
    - `Meta` directive class (moved from html.py) inserts `meta`
      (instead of `pending`) nodes.

but not detailed in the RELEASE-NOTES:

  * New standard Docutils doctree node: <meta__>.

I'll add a notice in the RELEASE-NOTES, too.


Thank you for reporting

Günter

[Docutils-develop] [docutils:bugs] #432 oblique not obligue

[Eric H. <esh...@us...>]

---

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

**Status:** open
**Created:** Fri Oct 29, 2021 09:44 PM UTC by Eric Hellman
**Last Updated:** Fri Oct 29, 2021 09:44 PM UTC
**Owner:** nobody


in 

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

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

should be 

`font-style: oblique;`



---

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

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

[Docutils-develop] [docutils:bugs] #427 Inconsistent sentence spacing in man pages using rst2man.py

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

As the example description is typeset justified, several blanks are stretched by one blank.

~~~
       character.  I  shall  pass them rapidly in review, without studying any
       particular arrangement.  The previous line will have been  spaced  with
       two spaces.

~~~

Experimenting I managed to get three blanks after the sentence end, which reduced one double blank in the following line
~~~
       character.   I  shall pass them rapidly in review, without studying any
       particular arrangement.  The previous line will have been  spaced  with
       two spaces.

~~~

so most important is to not break post-processors, the layout is random anyway.
Which might be the reason my man groff says nothing about sentences.
man 7 groff although states, without giving a reason:
>   In  text  paragraphs, it is advantageous to start each sentence at a line of its own.

and
>       newline
>              In  text paragraphs, newlines mostly behave like space characters.




---

** [bugs:#427] Inconsistent sentence spacing in man pages using rst2man.py**

**Status:** open
**Labels:** manpage-writer 
**Created:** Wed Oct 13, 2021 07:00 PM UTC by jei23jkfd
**Last Updated:** Fri Oct 29, 2021 05:14 PM UTC
**Owner:** nobody


## Operating system info

I'm running Docutils 0.18b2.dev r8848 with Python 3.9.

## Description of bug

The roff language has a very subtle requirement. It enforces semantic line breaks. That is, any roff document must end a sentence with a line break.

For example, this is incorrect:

~~~
This is a sentence. This is another sentence.
~~~

We have to insert a line break after each sentence:

~~~
This is a sentence.
This is another sentence.
~~~

The semantic line breaks are used to add optional sentence spacing. It uses the line breaks to detect when a period (or question or exclamation mark) represents the end of a sentence and then adds an optional extra space when displaying it. The relevant documentation for groff(1) and mandoc(1) is at

- https://www.gnu.org/software/groff/manual/groff.html#Sentences
- https://mandoc.bsd.lv/man/roff.7.html#Sentence_Spacing

## Minimal example

Here is a minimal example that shows how the reST man page writer has this bug:

~~~rst
###
mwe
###
a minimal example
#################
:Date: October 13, 2021
:Manual section: 1
:Manual group: Testing Docutils
:Version: mwe 0.1.0

Synopsis
========
| mwe [**-aq**] [**-b** *file*] [**\--long-long** *which*] *file \...*

Description
===========
To find the common attributes of a variety of objects, it is necessary
to begin, by surveying the *objects* themselves in the concrete. Let us
therefore advert successively to the various modes of action, and
arrangements of human affairs, which are classed, by universal or widely
spread opinion, as Just or as Unjust. The things well known to excite
the sentiments associated with those names, are of a very multifarious
character. I shall pass them rapidly in review, without studying any
particular arrangement.
The previous line will have been spaced with two spaces.

Options
=======
Its arguments are as follows:

-a                         Do all.
-q                         Be quiet.
-b file                    Do everything to *file*.
--long-meme which          Chooses the long named *which*.

Environment
===========
mwe is not affected by environment variables.

Exit status
===========
mwe exits 0 on success.
~~~

If you convert this with `rst2man.py mwe.rst mwe.1` and view it with `man ./mwe.1` you will notice the issue easily: some sentences in the DESCRIPTION section end with 1 space and some sentences end with 2 spaces.

## Possible solutions

The most complete solution would be to automatically detect where sentences end in the input and add line breaks as required in the man page output. This is what Pandoc does. However, it requires keeping a list of abbreviations for every language so as to not have false positives: you don't want to add a line break when someone uses "e.g.".

Another solution would be to use the `.ss` macro to remove the extra space at the end of any sentences. Then Docutils wouldn't have to conform to roff syntax. However, this would not work with mandoc(1) as the developer of that program has decided not to support `.ss`. This is what Asciidoctor does.

Please let me know if you have any questions.


---

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.