semvec/pypi-packages huggingface dataset:
msrst2db 1.4
A reStructuredText to DocBook converter using Python's docutils.

rst2db.py
=========

A reStructuredText to DocBook command-line converter using Python's docutils,
with an included Sphinx builder.

Using the command-line utility
------------------------------

::

  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.

Using the Sphinx builder
------------------------

Configuration
~~~~~~~~~~~~~

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 one configurable parameter for ``conf.py`` that correspond to
``rst2db.py`` parameters:

:docbook_default_root_element: default root element for a file-level document.
                               Default is 'section'.

Running a build
~~~~~~~~~~~~~~~

The builder is registered with the name 'docbook', so to run a build that uses
the builder, run ``sphinx-build`` with ``-b docbook``.


License
-------

This software is provided under the `BSD 3-Clause`__ license. See the
`LICENSE`__ file for more details.

.. __: http://opensource.org/licenses/BSD-3-Clause
.. __: https://github.com/Abstrys/abstrys-toolkit/blob/master/LICENSE

For more information
--------------------

Contact: Eron Hennessey <eron@abstrys.com>