| .. | ||
| _build/doctrees | ||
| _static | ||
| _templates | ||
| design | ||
| html | ||
| image_processing | ||
| images | ||
| tutorial | ||
| conf.py | ||
| doxyfile | ||
| doxygen-boost.css | ||
| footer.html | ||
| header.html | ||
| index.html | ||
| index.rst | ||
| installation.rst | ||
| io.rst | ||
| Jamfile | ||
| Makefile | ||
| naming.rst | ||
| numeric.rst | ||
| README.md | ||
| reference.dox | ||
| requirements.txt | ||
| toolbox.rst | ||
| warnings.txt | ||
Boost.GIL Documentation
A simple guide about writing and building documentation for Boost.GIL.
Prerequisites
- Python 3
- Install Sphinx (see
requirements.txt) - Install Doxygen
Installation
Create Python virtual environment:
$ python3 -m venv .venv
$ source ~/.venv/bin/activate
Install Sphinx and Sphinx extensions:
(.venv)$ cd boost-root
(.venv)$ pip install -r libs/gil/doc/requirements.txt
Build
$ echo "using doxygen ;" > ~/user-config.jam
$ cd boost-root
$ b2 libs/gil/doc