summaryrefslogtreecommitdiff
path: root/docutils/docs/api
Commit message (Collapse)AuthorAgeFilesLines
* Revert addition of `io.OutString` and the "auto_encode" argument.milde2023-05-021-53/+70
| | | | | | | 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.milde2023-04-281-1/+4
| | | | | | | | | | | | 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.milde2023-04-261-3/+8
| | | | | | | | 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.milde2023-04-121-2/+2
| | | | | | 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.milde2023-04-121-26/+51
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9343 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update "Publisher" documentation.milde2023-04-081-119/+161
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9340 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update Publisher API documentation.milde2022-12-131-18/+72
| | | | | | | | | | | | 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.milde2022-11-211-2/+2
| | | | | | | | | | | 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.milde2022-11-101-8/+21
| | | | | | | | | | | | | | | | | | | | | | | 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 updatesmilde2022-07-061-0/+8
| | | | | | | | | | 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
* Minimalistic menu bar for documentation pages.milde2022-04-023-0/+6
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9051 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation update and re-organisation.milde2022-04-013-68/+209
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9050 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Documentation fixes/clarifications.milde2022-03-032-12/+7
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@9014 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Update the Runtime Settings API documentation.milde2022-02-032-184/+215
| | | | | | | | | Update API documentation. Split implementation details into a separate document for core developers. git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8996 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Small documentation updates and fixes.milde2021-03-051-11/+19
| | | | git-svn-id: https://svn.code.sf.net/p/docutils/code/trunk@8631 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* change to :Contact: docutils-develop@lists.sourceforge.netgrubert2012-01-033-4/+3
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7302 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* add Maintenance contactgrubert2012-01-031-0/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@7301 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* latex2e writer: Place title data in the document preamble.milde2010-09-151-13/+12
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6416 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* New ``latex_preamble`` setting, PDF standard fonts as default.milde2009-11-301-6/+4
| | | | | | Use Times/Helvetica/Courier (the PDF standard fonts) as default fonts. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6204 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Updated template support: more parts, alternative templatemilde2009-09-021-20/+67
| | | | | | | | | | | | | | | Rename default template to "default.tex". Alternative template "titlepage.tex". Remove --use-titlepage-env option. LaTeXTranslator: sort initialization code. Generate PDF setup code unconditionally. Put in its own part so it can be (re)moved in a custom template. Comment out Writer.astext(). Put header and footer directive content in \\\\DUheader, \\\\DUfooter macros (not printed with the default style/template). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@6111 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Fix rst syntax and spurious whitespacemilde2009-06-191-11/+9
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5994 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* documentation update: Parts Provided by the LaTeX2e Writermilde2009-04-221-5/+14
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5916 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* update publish_parts for latex2e-writer.grubert2008-06-251-2/+24
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5576 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added introgoodger2008-05-071-2/+17
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5547 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* typogoodger2008-05-071-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5546 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixed documentation for publish_from_doctree to match actual behaviorwiemann2007-06-041-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@5214 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* use $Id$ instead of $Date$ and $Revision$;wiemann2006-05-211-4/+2
| | | | | | | | collapsed Author and Contact fields; use canonical email addresses for David and Felix; (I have reviewed the diff) git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4564 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added entries for publish_doctree & publish_from_doctreegoodger2006-04-041-0/+9
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4496 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Moved template functionality from the PEP/HTML writer to the HTML writer. ↵goodger2006-03-311-2/+73
| | | | | | Expanded the fragments available in the ``parts`` attribute (via publish_parts fn). git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@4456 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added more links; added note about body != html_bodywiemann2005-06-271-6/+7
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3599 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added link targets; note to self: need to document publish_(from_)doctreewiemann2005-06-271-15/+15
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3597 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixed linkswiemann2005-05-281-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3398 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* replaced references to the mailing lists with references to the newwiemann2005-05-281-2/+2
| | | | | | "mailing-lists" document git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3396 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added motivation for unresolved charsetwiemann2005-05-021-2/+3
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3283 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixed encoding/charset values in "html_prolog" & "html_head" parts, which ↵goodger2005-04-271-2/+12
| | | | | | should not have been interpolated git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3268 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Added ``html_prolog`` & ``html_head`` to HTML writer parts dictionary ↵goodger2005-04-261-0/+9
| | | | | | exposed by ``docutils.core.publish_parts``; updated tests & docs. At the request of Marcelo Huerta. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3257 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* Added ``html_body``, ``html_title``, & ``html_subtitle`` to HTML writer ↵goodger2005-04-241-4/+79
| | | | | | parts dictionary exposed by ``docutils.core.publish_parts``; updated tests. Added "``publish_parts`` Details" section to docs/api/publish.txt. git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@3251 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* clarified & extendedgoodger2005-02-251-20/+27
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2982 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added link to examples.pywiemann2005-01-011-1/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2920 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* typowiemann2004-09-191-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2627 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updated; added linkwiemann2004-09-141-3/+6
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2612 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixgoodger2004-06-271-1/+1
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2404 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* typogoodger2004-06-271-4/+4
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2403 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedgoodger2004-06-271-4/+9
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2402 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* updatedgoodger2004-06-271-1/+4
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2401 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixgoodger2004-06-271-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2398 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* fixgoodger2004-06-271-2/+2
| | | | git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2397 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
* added to projectgoodger2004-06-273-0/+321
git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@2394 929543f6-e4f2-0310-98a6-ba3bd3dd1d04
View Lorry Controller Status