Skip to main content

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.

For more information

Contact: Eron Hennessey <eron@abstrys.com>

Metadata

Release files for msrst2db 1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for msrst2db 1.4
File Size Uploaded Provenance Actions
msrst2db-1.4.tar.gz 7.7 kB Without provenance Details for msrst2db-1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for msrst2db 1.4
File Interpreter ABI Platform Actions
msrst2db-1.4-py2.py3-none-any.whl Python 2, Python 3 none any Details for msrst2db-1.4-py2.py3-none-any.whl

Total release size: 16.7 kB

Release files / msrst2db-1.4.tar.gz

Download URL msrst2db-1.4.tar.gz
Size 7.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a7419f2c9411a54ccdb7c3e0b1333ed6a24031832e362eaad42b226018a12231
BLAKE2b-256 checksum
How to use checksums
cd3a4e2a5fe67dc22d591183643f205b026e2eedd0168b90c6f5883c6e07826c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / msrst2db-1.4-py2.py3-none-any.whl

Download URL msrst2db-1.4-py2.py3-none-any.whl
Size 9.1 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
b1069b5e50820db82877d10cccf20804a5cff4653ef95b34c98c61080a2d5983
BLAKE2b-256 checksum
How to use checksums
be9e517b5511c3dbb2913b5c5b169c272575d1c6fbc0e009ef34e18c1b60610b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for msrst2db 1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page