From 48258879720a4f423d0efa955da942d69f3c49d4 Mon Sep 17 00:00:00 2001 From: Ben McGinnes Date: Fri, 5 Oct 2018 01:47:56 +1000 Subject: docs: python * lang/python/doc/meta/TODO.org: Added the two major documentation build system tasks to the TODO list. * Added an index page in preparation for sorting out the second of those TODO lists (Docutils is a lot easier to handle than Texinfo). * Meanwhile, have confirmed that it all builds just fine under GNU/Linux, OS X and FreeBSD while retaining the documentation, so that's a nice improvement from 1.11.1. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes --- lang/python/doc/meta/TODO.org | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'lang/python/doc/meta') diff --git a/lang/python/doc/meta/TODO.org b/lang/python/doc/meta/TODO.org index add8f4ff..0be99b30 100644 --- a/lang/python/doc/meta/TODO.org +++ b/lang/python/doc/meta/TODO.org @@ -29,6 +29,38 @@ through converting to either Markdown or XHTML first. +** TODO Documentation build systems + :PROPERTIES: + :CUSTOM_ID: todo-docs-build-systems + :END: + +Though Org Mode is being used for the default documentation format, it +still needs to end up as usable by end users. So the Org Mode files +are used to produce the "source" files used by the two main contenders +for documenting the bindings: Texinfo and ReStructuredText/Docutils. + + +*** TODO Texinfo documentation + :PROPERTIES: + :CUSTOM_ID: todo-docs-build-texinfo + :END: + +Need to add all of Texinfo's ... special systems to make it do its +things. + + +*** TODO ReStructuredText documentation + :PROPERTIES: + :CUSTOM_ID: todo-docs-build-docutils + :END: + +Need to run Sphinx's quick start, add it to the requirements and tweak +the index page for the rst files to point to the HOWTO and other files. + +It might just be easier to do all that in Org Mode and convert the +lot, then the Sphinx bits can be automated. + + ** STARTED Documentation HOWTO :PROPERTIES: :CUSTOM_ID: todo-docs-howto -- cgit v1.2.3