README: Expand Local build instructions

This better covers how to build on Debian and Ubuntu.

Signed-off-by: Richard Laager <rlaager@wiktel.com>
This commit is contained in:
Richard Laager
2020-05-22 16:46:48 -05:00
parent 999405d73c
commit 5140c6caa3

View File

@@ -1,19 +1,39 @@
.. 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/
Local build
-----------
Building Locally
----------------
Install Prerequisites
~~~~~~~~~~~~~~~~~~~~~
Debian 11 (“testing”) / Ubuntu 20.04 or later::
sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme
Debian 10 (”Buster”) and earlier::
sudo apt install pip3
pip3 install -r requirements.txt
# Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
PATH=$HOME/.local/bin:$PATH
Other distros::
pip install -r requirements.txt
# Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc:
PATH=$HOME/.local/bin:$PATH
Build
~~~~~
::
cd ./docs/
# install dependencies:
pip install -r requirements.txt
# run `sphinx` to build pages
cd docs
make html
# html files will be generated in:
cd ./docs/_build/html/
# HTML files will be generated in: _build/html