-------------------------------------
lines 110-215 of file: user/user.xrst
-------------------------------------

{xrst_begin user-guide user}
{xrst_spell
   grep
   pdf
   pypi
   pyproject
   pytest
   url
}

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 <https://spdx.org/licenses/GPL-3.0-or-later.html>`_

Git Repository
**************
`<https://github.com/bradbell/xrst>`_

{xrst_comment BEGIN: Before changing see bin/new_release and check_version.sh}

Versions
********

.. list-table::
   :widths: auto

   * - This version
     - xrst-2025.5.11
   * - Documentation for latest version
     - `latest <https://xrst.readthedocs.io/latest>`_
   * - Documentation for most recent stable version
     - `stable-2025 <https://xrst.readthedocs.io/stable-2025>`_
   * - Most recent release of this stable version
     - `release-2025 <https://codeload.github.com/bradbell/xrst/tar.gz/refs/tags/2025.0.5>`_

{xrst_comment END: Before changing see bin/new_release and check_version.sh}

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
{xrst_comment END: Before changing see bin/ new_release and check_version.sh}

Install Testing Version
***********************
Search for ``xrst`` on `test.pypi <https://test.pypi.org>`_
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):
{xrst_literal
   pyproject.toml
   # BEGIN_DEPENDENCIES
   # END_DEPENDENCIES
}


Run Program
***********
:ref:`run_xrst-title`

Contents
********
{xrst_toc_list
   xrst/get_conf_dict.py
   xrst/run_xrst.py
   user/commands.xrst
   user/automatic.xrst
   user/wish_list.xrst
}

{xrst_end user-guide}