user-guide

View page source

Extract Sphinx RST Files

This is a sphinx wrapper that extracts RST file from source code and then runs sphinx to obtain html, tex, or pdf output files. It includes automatic processing and commands that make sphinx easier to use.

License

GPL-3.0-or-later

Git Repository

https://github.com/bradbell/xrst

Versions

This version

xrst-2025.4.17

Documentation for latest version

latest

Documentation for most recent stable version

stable-2025

Most recent release of this stable version

release-2025

Install Stable Version

Features in stable-2025 were frozen at the beginning of the year and only includes bug fixed after that.

pip install xrst

Install Testing Version

Search for xrst on test.pypi to determine the date corresponding to this version. This installs the xrst dependencies and then replaces xrst by its most recent test version:

pip install xrst
pip uninstall -y xrst
pip install --index-url https://test.pypi.org/simple/ xrst

Install From Source

The following commands will download, test, build, and install the current version from the master branch.

git clone https://github.com/bradbell/xrst.git xrst.git
cd xrst.git
pytest -s pytest
pip install .

You can determine the date corresponding to a version of the source code using the following command:

grep '^version *=' pyproject.toml

Dependencies

The following is a list of the projects that xrst depends on (and should be automatically installed by pip when you install xrst):

dependencies      = [
   # Always requires to run xrst
   'sphinx', 'tomli', 'sphinx-copybutton',
   # The default spell checker
   'pyspellchecker',
   # The default theme
   'furo',
]

Run Program

Extract RST Files And Run Sphinx

Contents