A reStructuredText to DocBook command-line converter using Python's docutils, with an included Sphinx builder.
rst2db <filename> [-e root_element] [-o output_file] [-t template_file]
Only the filename to process is required. All other settings are optional.
Settings:
-e root_element set the root element of the resulting docbook file. If this is not specified, then 'section' will be used. -o output_file set the output filename to write. If this is not specified, then output will be sent to stdout. -t template_file set a template file to use to dress the output. You must have Jinja2 installed to use this feature.
Use {{data.root_element}} and {{data.contents}} to represent the output of this script in your template.
To build docbook output with Sphinx, add abstrys.docbook.builder to the
extensions list in conf.py:
extensions = [ ... other extensions here ... abstrys.sphinx.docbook_builder ]
There are two configurable parameters for conf.py that correspond to
rst2db.py parameters:
| docbook_template_file: | template file that will be used to position the document parts. Requires Jinja2 to be installed if specified. |
|---|---|
| docbook_default_root_element: | default root element for a file-level document. Default is 'section'. |
The builder is registered with the name 'docbook', so to run a build that uses
the builder, run sphinx-build with -b docbook.
This software is provided under the BSD 3-Clause license. See the LICENSE file for more details.
Contact: Eron Hennessey <[email protected]>