{section: Prerequisites} -1: Install Python. *You must install Python 3+*. We no longer support Python 2. -*:: https://www.python.org/downloads -*:: Make sure your =$PYTHONPATH= environment variable is set to include the Condor Python bindings. In the following example, replace the =<htcondor-release-dir>= tag with the correct path: -{code} -export PYTHONPATH=<htcondor-release-dir>/lib/python3:$PYTHONPATH -{endcode} +1: Install Python (https://www.python.org/downloads, or you system package manager). *You must install Python 3+*. We no longer support Python 2. -1: Install Sphinx and related support packages. The recommended way to install Sphinx is via `pip`: +1: Install Sphinx and related support packages. The recommended way to install Sphinx is via `pip`, and we recommend using our pinned dependencies: {code} pip3 install --user -r docs/requirements.txt {endcode} @@ -28,10 +23,14 @@ Windows and Mac installers can be found at https://github.com/jgm/pandoc/releases/ 1: 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 =.so= files inside your HTCondor install. -Note: on RTD itself, the docs are built using the =htcondor= version read out of =CMakeLists.txt= +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): +{code} +export PYTHONPATH=<htcondor-release-dir>/lib/python3:$PYTHONPATH +{endcode} +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=. -1: Install the Python pathlib module if you're on Python <= 3.4: +1: If you're on Python <= 3.4 (editorial note: why?!), install the =pathlib= compatibility module: {code} pip3 install --user pathlib {endcode}