seadanda / doc-cvmfs

CernVM-FS Documentation

CernVM-FS Documentation

This contains the rST sources and image assets for the CernVM-FS user documentation.

Building the HTML documentation

The official CernVM-FS documentation is built automatically by readthedocs.org. Nevertheless, one can easily build it locally for editing purposes or different output formats.

The build requirements for the documentation are Sphinx and the Sphinx RTD theme. Both of which can be conveniently installed via pip:

pip install Sphinx sphinx_rtd_theme

Afterwards a simple make html in this repository's root directory generates the documentation in _build/html/. Opening _build/html/index.html in any browser is enough.