mirror of
https://github.com/boostorg/gil.git
synced 2026-01-29 07:32:18 +00:00
4ed7701b47
Split header tests accordingly i.e. test core headers as part of core tests, numeric extension headers as part of numeric tests, etc. It extends the convention of sub-directories already established in `include/boost/gil` directory. It is sensible to follow it in other areas of the source tree (i.e. `test/`, `doc/` and `benchmark/`). Another important reason to move the tests is to enable removal of the top-level `Jamfile` with all its definitions of test-specific requirements. The top-level `Jamfile` is not advised, especially if it specifies build requirements like C++ language version. Those affect non-tests builds e.g. documentation, causing failures during generation of HTML documentation (leads to missing docs).
Boost.GIL Documentation
A simple guide about writing and building documentation for Boost.GIL.
Prerequisites
- Python 3.4+
- Install Sphinx
- Install Doxygen
Installation
Create Python virtual environment:
$ cd boost/libs/gil
$ python3 -m venv .venv
$ source ./.venv/bin/activate
Install Sphinx and Sphinx extensions:
(.venv)$ pip install -r doc/requirements.txt
Build
TODO