openzfs/openzfs-docs

OpenZFS Documentation

Python

OpenZFS Documentation

Public link: https://openzfs.github.io/openzfs-docs/

Building Locally

Install Prerequisites

The dependencies are available via pip:

# For Debian based distros
sudo apt install python3-pip
# For RPM-based distros
sudo yum install python3-pip
# For openSUSE
sudo zypper in python3-pip

pip3 install -r docs/requirements.txt
# Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
PATH=$HOME/.local/bin:$PATH

Build

cd docs
make html
# HTML files will be generated in: _build/html