To build the PDAL documentation yourself, you need to install the following items:
Python dependencies should be installed from PyPI with
(sudo) pip install sphinx sphinxconfig-bibtex breathe
If you are installing these packages to a system-wide directory, you may need the sudo in front of the pip, though it might be better that instead you use virtual environments instead of installing the packages system-wide.
The PDAL documentation also depends on Doxygen, which can be installed from
source or from binaries from the doxygen website. If you are on Max OS X
and use homebrew, you can install doxygen with a simple
Once you have installed all the doc dependencies, you can then build the
documentation itself. The
doc/ directory in the PDAL source tree
contains a Makefile which can be used to build all documentation. For a list
of the output formats supported by Sphinx, simply type
make. For example,
to build html documentation:
cd doc make doxygen html
The http://pdal.io website is regenerated from the
*-maintenance branch using
Travis. It will be committed by the
PDAL-docs GitHub user and pushed
to the https://github.com/PDAL/pdal.github.io repository. The website
is then served via GitHub Pages.
The website is regenerated and pushed only on the
call. If the tests aren’t passing, the website won’t be updated.