No description
  • Python 86.7%
  • Shell 13.1%
  • Makefile 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
George Melikov d78abcf79b Debian: fix popcon typo and missing apt --yes flags
Say 'packages installed' rather than 'packages install' in the popcon
step of all Debian guides, and pass --yes to the systemd-timesyncd,
dosfstools and tasksel installs in the Trixie guide, matching every
other apt invocation in that guide.
2026-07-21 13:20:45 +03:00
.github/workflows Use sphinx>=8 and disable shallow clone in CI 2025-12-01 10:05:15 +03:00
docs Debian: fix popcon typo and missing apt --yes flags 2026-07-21 13:20:45 +03:00
scripts Remove llms_txt_code_files 2026-01-09 17:51:55 +03:00
.readthedocs.yaml added conf file to build readthedocs page 2025-11-29 21:10:16 +03:00
Makefile Add a top-level Makefile 2020-05-27 13:12:55 -05:00
README.rst Introduce tox to manage python venv 2025-11-24 13:37:04 +03:00
tox.ini Introduce tox to manage python venv 2025-11-24 13:37:04 +03:00

.. image:: docs/_static/img/logo/480px-Open-ZFS-Secondary-Logo-Colour-halfsize.png
.. highlight:: sh

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

Or, you can use tox::

   tox -e develop
   . .tox/develop/bin/activate

Build
~~~~~

::

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