Read the Docs Overview

In 2019 we migrated the HTCondor Manual from our old LaTeX format into the Sphinx documentation generator using the reStructuredText format. We will also be hosting it on Read the Docs. The manual can be found here:


  1. Install Python (, or you system package manager). You must install Python 3+. We no longer support Python 2.

  2. Install Sphinx and related support packages. The recommended way to install Sphinx is via `pip`, and we recommend using our pinned dependencies:
    pip3 install --user -r docs/requirements.txt
    On RHEL and CentOS we do not support installing Sphinx from yum or RPM. The available package is an old version which does not support all our extensions. For other Linux distributions, Windows and macOS, you can find instructions here:

  3. Install pandoc. On RHEL, for example:
    sudo yum install pandoc
    Windows and Mac installers can be found at

  4. Install the HTCondor Python bindings. This could be via pip (make sure you get the right version, e.g. pip3 install htcondor==8.8.1), or by editing your PYTHONPATH environment variable to point at the packages in your HTCondor build. For example (replacing <htcondor-release-dir> with your local release directory path):
    export PYTHONPATH=<htcondor-release-dir>/lib/python3:$PYTHONPATH
    Note: on RTD, the docs are built using the pip-installed htcondor version read out of CMakeLists.txt, and the package versions in docs/requirements.txt.

  5. If you're on Python <= 3.4 (editorial note: why?!), install the pathlib compatibility module:
    pip3 install --user pathlib

  6. [Optional] Install This is useful if you're making lots of quick edits to the manual and expect to build it many times.
    pip3 install --user sphinx-autobuild
    See below for instructions on using sphinx-autobuild.


Building and previewing the manual locally

Using sphinx-autobuild to build and preview

Instead of the instructions in the previous section, go to /docs and run

sphinx-autobuild . _build/html
You will see a log of the Sphinx build running, and eventually will be provided a link to a localhost webserver hosting the docs. Leave this program running: sphinx-autobuild will watch the docs source tree for changes and rebuild when it detects changes (you may still need to manually reload the page inside your web browser, but it will usually force a refresh by itself).

Different versions of the manual

Formatting Guidelines

See the Manual Formatting Guidelines page.


Publishing the manual onto Read the Docs

Different versions of the manual

Generating man pages