From a1497797972199c74fac5c1a75b6ac694d316021 Mon Sep 17 00:00:00 2001 From: goodger Date: Tue, 4 Apr 2006 03:06:59 +0000 Subject: [PATCH] added entries for publish_doctree & publish_from_doctree git-svn-id: https://docutils.svn.sourceforge.net/svnroot/docutils/trunk/docutils@4496 929543f6-e4f2-0310-98a6-ba3bd3dd1d04 --- docs/api/publisher.txt | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/publisher.txt b/docs/api/publisher.txt index 769153f87..11f9aaaad 100644 --- a/docs/api/publisher.txt +++ b/docs/api/publisher.txt @@ -39,6 +39,15 @@ handles everything else. There are five convenience functions in the There are usage examples in the `docutils/examples.py`_ module. +:_`publish_doctree`: for programmatic use with string input; returns a + Docutils document tree data structure (doctree). The doctree can be + modified, pickled & unpickled, etc., and then reprocessed with + `publish_from_doctree`_. + +:_`publish_from_doctree`: for programmatic use to render from an + existing document tree data structure (doctree); returns a pair of + encoded string output and document parts. + :_`publish_programmatically`: for custom programmatic use. This function implements common code and is used by ``publish_file``, ``publish_string``, and ``publish_parts``. It returns a 2-tuple: -- 2.11.4.GIT