Richard Laager ae6aa9cb4d Debian/Ubuntu: Cleanup formatting
This cleans up a bunch of formatting from the rst conversion.  I didn't
make the manual fixes to the 16.04 or Stretch versions, since they
aren't really being maintained these days and are just for reference for
existing installations.

Signed-off-by: Richard Laager <rlaager@wiktel.com>
2020-05-26 14:40:24 -05:00
2020-05-26 14:40:24 -05: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
~~~~~~~~~~~~~~~~~~~~~

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
   make html
   # HTML files will be generated in: _build/html
Description
OpenZFS Documentation
Readme 2 MiB
Languages
Python 83.7%
Shell 16.1%
Makefile 0.2%