<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/docutils.git/docs/api, branch docutils-0.20</title>
<subtitle>svn.code.sf.net: p/docutils/code
</subtitle>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/'/>
<entry>
<title>Revert addition of `io.OutString` and the "auto_encode" argument.</title>
<updated>2023-05-02T23:04:27+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-05-02T23:04:27+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=9da16f916e138b6338d50bfaf67276477f2563c5'/>
<id>9da16f916e138b6338d50bfaf67276477f2563c5</id>
<content type='text'>
We need a review of the "string output" interface and a consensus
on the "clean" end-state before starting with the implementation.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9369 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
We need a review of the "string output" interface and a consensus
on the "clean" end-state before starting with the implementation.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9369 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Add output encoding error handler to the parts provided by all writers.</title>
<updated>2023-04-28T21:26:36+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-04-28T21:26:36+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=c9c4e3598dd04853fc82c9c66bc993d8741a5710'/>
<id>c9c4e3598dd04853fc82c9c66bc993d8741a5710</id>
<content type='text'>
The new generic part "errors" returned by default
contains the `output_encoding_error_handler` setting,
which may make-or-break encoding ``parts['whole']``.

Allows use of `core.publish_parts()` to get the document as `str`,
post-process it and encode with user configurated encoding and
encoding-error handler.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9368 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The new generic part "errors" returned by default
contains the `output_encoding_error_handler` setting,
which may make-or-break encoding ``parts['whole']``.

Allows use of `core.publish_parts()` to get the document as `str`,
post-process it and encode with user configurated encoding and
encoding-error handler.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9368 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Documentation fix/update.</title>
<updated>2023-04-26T21:00:10+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-04-26T21:00:10+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=247af50534fee5834ef9812c04322e4a56707cce'/>
<id>247af50534fee5834ef9812c04322e4a56707cce</id>
<content type='text'>
The return value of `io.FileOutput` (and hence of `core.publish_cmdline()`
and `core.publish_file()`) is a `str` instance (except for
binary output document formats) and has always been under Python 3.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9366 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
The return value of `io.FileOutput` (and hence of `core.publish_cmdline()`
and `core.publish_file()`) is a `str` instance (except for
binary output document formats) and has always been under Python 3.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9366 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix typo.</title>
<updated>2023-04-12T16:52:19+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-04-12T16:52:19+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=5902855e0fcba7777562253586c8cb52ec9c1423'/>
<id>5902855e0fcba7777562253586c8cb52ec9c1423</id>
<content type='text'>
Reported by Adam Turner.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9344 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Reported by Adam Turner.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9344 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Update Publisher API documentation. Add links.</title>
<updated>2023-04-12T15:11:38+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-04-12T15:11:38+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=f614bb6f10252cb9caeda464e00b42008f7d6b14'/>
<id>f614bb6f10252cb9caeda464e00b42008f7d6b14</id>
<content type='text'>
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9343 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9343 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Update "Publisher" documentation.</title>
<updated>2023-04-08T21:09:08+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2023-04-08T21:09:08+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=e60816ce6322153bf58f75a798092526ca0fee66'/>
<id>e60816ce6322153bf58f75a798092526ca0fee66</id>
<content type='text'>
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9340 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9340 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Update Publisher API documentation.</title>
<updated>2022-12-13T21:45:32+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2022-12-13T21:45:32+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=295bccc6a75d71b89db16f6c5a3063d934dcba9e'/>
<id>295bccc6a75d71b89db16f6c5a3063d934dcba9e</id>
<content type='text'>
Use Python 3 terminology: "Unicode string" -&gt; `str` instance.

Document "string I/O" (input/output using `str` or `bytes` instances).

Document input encoding auto-detection.

Specify the behaviour and the "explicit encoding declaration".

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9309 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Use Python 3 terminology: "Unicode string" -&gt; `str` instance.

Document "string I/O" (input/output using `str` or `bytes` instances).

Document input encoding auto-detection.

Specify the behaviour and the "explicit encoding declaration".

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9309 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Small documentation fixes.</title>
<updated>2022-11-21T20:51:23+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2022-11-21T20:51:23+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=1e26ab5be2bbf3678a07d94f43e9d1ac09fb9d75'/>
<id>1e26ab5be2bbf3678a07d94f43e9d1ac09fb9d75</id>
<content type='text'>
transforms.txt:
  Update "added by" in "Transforms Listed in Priority Order".

io.py:
  reword docstrings and assertion messages,
  use PEP 257 "Docstring Conventions".

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9259 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
transforms.txt:
  Update "added by" in "Transforms Listed in Priority Order".

io.py:
  reword docstrings and assertion messages,
  use PEP 257 "Docstring Conventions".

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9259 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Fix/complement publisher documentation and tests.</title>
<updated>2022-11-10T15:02:17+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2022-11-10T15:02:17+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=5f98d61c468e7625a73c919fd41e506e5c74b34b'/>
<id>5f98d61c468e7625a73c919fd41e506e5c74b34b</id>
<content type='text'>
API documentation:

- Spell out ampersand (&amp;) as "and".
- Finish description of part "pepnum".
- Add links to LaTeX templates.
- Remove trailing whitespace.

Docstrings:

- Clarify source and output data type for functions using
  "string I/O" (with "string" in the general sense of "`str` or `bytes`").
- Recommend using publish_parts() to get Docutils output as `str`.
- Add "()" to functions so that pydoc HTML rendering generates auto-links.
- Add links to the HTML documentation.

Tests:

- Add test for input/output data types of publish_string().

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9235 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
API documentation:

- Spell out ampersand (&amp;) as "and".
- Finish description of part "pepnum".
- Add links to LaTeX templates.
- Remove trailing whitespace.

Docstrings:

- Clarify source and output data type for functions using
  "string I/O" (with "string" in the general sense of "`str` or `bytes`").
- Recommend using publish_parts() to get Docutils output as `str`.
- Add "()" to functions so that pydoc HTML rendering generates auto-links.
- Add links to the HTML documentation.

Tests:

- Add test for input/output data types of publish_string().

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9235 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
<entry>
<title>Documentation updates</title>
<updated>2022-07-06T13:59:57+00:00</updated>
<author>
<name>milde</name>
<email>milde@929543f6-e4f2-0310-98a6-ba3bd3dd1d04</email>
</author>
<published>2022-07-06T13:59:57+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/docutils.git/commit/?id=067148a9148e574b6048d02fa0486fb5f27e0e2c'/>
<id>067148a9148e574b6048d02fa0486fb5f27e0e2c</id>
<content type='text'>
Document future changes regarding front-end tools.

Clarify/update planned changes to the input-encoding handling.

Various smaller fixes. Add links.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9107 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Document future changes regarding front-end tools.

Clarify/update planned changes to the input-encoding handling.

Various smaller fixes. Add links.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk/docutils@9107 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
</pre>
</div>
</content>
</entry>
</feed>
