delta/python-packages/docutils.git/docutils/docs/api, branch master

Revert addition of `io.OutString` and the "auto_encode" argument.

2023-05-02T23:04:27+00:00

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@9369 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Add output encoding error handler to the parts provided by all writers.

2023-04-28T21:26:36+00:00

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@9368 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Documentation fix/update.

2023-04-26T21:00:10+00:00

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@9366 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Fix typo.

2023-04-12T16:52:19+00:00

Reported by Adam Turner.

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9344 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Update Publisher API documentation. Add links.

2023-04-12T15:11:38+00:00

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9343 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Update "Publisher" documentation.

2023-04-08T21:09:08+00:00

git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9340 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Update Publisher API documentation.

2022-12-13T21:45:32+00:00

Use Python 3 terminology: "Unicode string" -> `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@9309 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Small documentation fixes.

2022-11-21T20:51:23+00:00

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@9259 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Fix/complement publisher documentation and tests.

2022-11-10T15:02:17+00:00

API documentation:

- Spell out ampersand (&) 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@9235 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

Documentation updates

2022-07-06T13:59:57+00:00

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@9107 929543f6-e4f2-0310-98a6-ba3bd3dd1d04