libs/gil/doc/README.md

   1 # Boost.GIL Documentation
   2
   3 A simple guide about writing and building documentation for Boost.GIL.
   4
   5 ## Prerequisites
   6
   7 - Python 3
   8 - [Install Sphinx](#install-sphinx) (see `requirements.txt`)
   9 - Install [Doxygen](http://www.doxygen.org)
  10
  11
  12 ## Installation
  13
  14 Create Python virtual environment:
  15
  16 ```console
  17 $ python3 -m venv .venv
  18 $ source ~/.venv/bin/activate
  19 ```
  20
  21 Install Sphinx and Sphinx extensions:
  22
  23 ```console
  24 (.venv)$ cd boost-root
  25 (.venv)$ pip install -r libs/gil/doc/requirements.txt
  26 ```
  27
  28 ## Build
  29
  30 ```console
  31 $ echo "using doxygen ;" > ~/user-config.jam
  32 $ cd boost-root
  33 $ b2 libs/gil/doc
  34 ```