eUgEntOptIc44/docutils
1
0
Fork 0
mirror of git://repo.or.cz/docutils.git synced 2025-10-06 00:32:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

Documentation fixes.

Browse Source 
Fix docstring: `directives.misc.Include.insert_into_input_lines()`
returns None. (The empty list is returned by `Include.run()`.)

Small edits in the Document Tree Guide.

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@10214 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
This commit is contained in:
milde
2025-08-20 09:39:58 +00:00
parent 4e75703fc9
commit 357763714d
2 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docutils/docs/ref/doctree.rst
View File

@@ -4385,8 +4385,8 @@ Attribute type: `CDATA`_. Default value: none.
The ``auto`` attribute is used to indicate automatically-numbered
`\<footnote>`_, `\<footnote_reference>`_ and `\<title>`_ elements
(via the `%auto.att`_ parameter entity).
In <footnote> and <footnote_reference> elements, it also carries information
about the label type: "1": auto-numbered_, "*": auto-symbol_.
In `\<footnote>`_ and `\<footnote_reference>`_ elements, it also carries
information about the label type ("1": auto-numbered_, "*": auto-symbol_).
``backrefs``
@@ -4925,10 +4925,13 @@ Attribute type: `CDATA`_. Default value: none.
The ``title`` attribute is used in the `\<document>`_ element to store the
document's *metadata title*.
It is set by the `"title" directive`_ or the `DocTitle transform`_.
This title is typically not part of the rendered document.
It is, for example, used as `HTML <title> element`_ and shown in a
browser's title bar, in a user's history or bookmarks, or in search results.
The attribute is set by the `"title" directive`_ or the
`DocTitle transform`_. It is typically not part of the rendered document
but, for example, used as `HTML <title> element`_ and shown in a
browser's title bar, a user's history or bookmarks, or search results.
Its value may may differ from the *displayed title* which is stored in a
`\<title>`_ element.
.. _HTML <title> element:
https://html.spec.whatwg.org/multipage/semantics.html#the-title-element

2
docutils/docutils/parsers/rst/directives/misc.py
View File

@@ -236,8 +236,6 @@ class Include(Directive):
def insert_into_input_lines(self, text: str) -> None:
"""Insert file content into the rST input of the calling parser.
Returns an empty list to comply with the API of `Directive.run()`.
Provisional.
"""
source = self.options['source']