https://github.com/openzfs/openzfs-docs

OpenZFS Documentation
https://github.com/openzfs/openzfs-docs

documentation

Last synced: 1 day ago
JSON representation

OpenZFS Documentation

• Host: GitHub
• URL: https://github.com/openzfs/openzfs-docs
• Owner: openzfs
• Created: 2020-05-20T17:59:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-12T08:17:20.000Z (about 2 months ago)
• Last Synced: 2025-01-26T01:05:12.030Z (9 days ago)
• Topics: documentation
• Language: Python
• Homepage: https://openzfs.github.io/openzfs-docs/
• Size: 8.3 MB
• Stars: 141
• Watchers: 19
• Forks: 200
• Open Issues: 52
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
.. 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

Build

~~~~~

::

   cd docs

   make html

   # HTML files will be generated in: _build/html