5. Generate Documentation

Before generating the Sphinx documentation, you should compile the package. First, get the source code from the GitHub repository.

git clone https://github.com/ameli/detkit.git
cd detkit

If you already had the source code, clean it from any previous build (especially if you built in-source):

python setup.py clean

5.1. Compile Package

Set CYTHON_BUILD_FOR_DOC to 1 (see Configure Compile-Time Environment variables). Compile and install the package by

UNIX

export CYTHON_BUILD_FOR_DOC=1
sudo -E python setup.py install

Windows (Powershell)

$env:CYTHON_BUILD_FOR_DOC = "1"
sudo -E python setup.py install

5.2. Generate Sphinx Documentation

Install Pandoc by

Ubuntu/Debian

sudo apt install pandoc -y

CentOS 7

sudo yum install pandoc -y

RHEL 9

sudo dnf install pandoc -y

macOS

sudo brew install pandoc -y

Windows (Powershell)

scoop install pandoc

Install the requirements for the Sphinx documentation by

python -m pip install -r docs/requirements.txt

The above command installs the required packages in Python’s path directory. Make sure python’s directory is on the PATH, for instance, by

UNIX

PYTHON_PATH=`python -c "import os, sys; print(os.path.dirname(sys.executable))"`
export PATH=${PYTHON_PATH}:$PATH

Windows (Powershell)

$PYTHON_PATH = (python -c "import os, sys; print(os.path.dirname(sys.executable))")
$env:Path += ";$PYTHON_PATH"

Now, build the documentation:

UNIX

make clean html --directory=docs

Windows (Powershell)

cd docs
make.bat clean html

The main page of the documentation can be found in /docs/build/html/index.html.