This repostitory contains scripts and files for generating API documenations automatically.
We are using
Doxygen: http://www.stack.nl/~dimitri/doxygen/
Breathe: https://github.com/michaeljones/breathe
Exhale: https://github.com/svenevs/exhale
Sphinx: http://www.sphinx-doc.org/en/stable/
ReadTheDocs: https://readthedocs.org/
...
- Clone the PointCloudLibrary repository.
- Run Doxygen to generate .xml files.
- Run make_source.py to generate .rst files from .xml files.
- Run Sphinx with Breathe exntension to generate .html files.
Github will send a signal to ReadTheDocs when the PointCloudLibrary repository has a update.
Therefore, step 2-5 will be ran on ReadTheDocs automatically.
The API documentation will be available at: https://pcl.readthedocs.org
$ conda env create -f environment.yml
$ conda activate pcl-docs
$ make html
Please feel free to contact to the author (t753github@gmail.com) if you have a question.