boost/gil

mirror of https://github.com/boostorg/gil.git synced 2026-02-19 14:32:10 +00:00

Files

Mateusz Łoskot 42a14c1f4c Fix Sphinx warnig about html_add_permalinks type [ci skip]

WARNING: The config value `html_add_permalinks' has type `bool',
         defaults to `str'.

2018-11-20 19:41:36 +01:00

_static

Update documentation.

2018-06-27 00:02:27 -04:00

_templates

Update documentation.

2018-06-27 00:02:27 -04:00

doxygen

Rename point2<T> to point<T> (#155 )

2018-10-19 09:32:23 +02:00

images

Update documentation.

2018-06-27 00:02:27 -04:00

adobe_logo.gif

Removed executable attribute from files.

2017-11-05 02:58:03 +02:00

adobe_source.css

Make the gil doxygen docs a litte more boost friendly and a bit to build.

2009-05-02 12:39:02 +00:00

boost.png

Removed executable attribute from files.

2017-11-05 02:58:03 +02:00

build.sh

Make the gil doxygen docs a litte more boost friendly and a bit to build.

2009-05-02 12:39:02 +00:00

conf.py

Fix Sphinx warnig about html_add_permalinks type [ci skip]

2018-11-20 19:41:36 +01:00

design_guide.rst

Rename point2<T> to point<T> (#155 )

2018-10-19 09:32:23 +02:00

doxyfile

[doc] Add BOOST_GIL_DOXYGEN_ONLY to Doxyfile [ci skip]

2018-06-27 00:02:27 -04:00

doxygen-boost.css

Update documentation.

2018-06-27 00:02:27 -04:00

footer.html

Update documentation.

2018-06-27 00:02:27 -04:00

header.html

Update documentation.

2018-06-27 00:02:27 -04:00

index.html

Update documentation.

2018-06-27 00:02:27 -04:00

index.rst

Tidy up, some doc8 linting, tabs to spaces.

2018-06-27 00:02:27 -04:00

io.rst

Update documentation for new IO extension file layout.

2018-06-27 00:02:27 -04:00

Jamfile

Simplify and clean up Jamfiles

2018-09-21 18:02:37 +02:00

Makefile

Update documentation.

2018-06-27 00:02:27 -04:00

numeric.rst

Tidy up, some doc8 linting, tabs to spaces.

2018-06-27 00:02:27 -04:00

README.md

Start doc/README.md document [ci skip]

2018-11-20 15:59:01 +01:00

reference.dox

Update documentation.

2018-06-27 00:02:27 -04:00

requirements.txt

Remove Exhale from doc/requirements.txt [ci skip]

2018-11-20 16:09:19 +01:00

rst.css

Update documentation.

2018-06-27 00:02:27 -04:00

shorten_file_name.sh

Make the gil doxygen docs a litte more boost friendly and a bit to build.

2009-05-02 12:39:02 +00:00

toolbox.rst

Tidy up, some doc8 linting, tabs to spaces.

2018-06-27 00:02:27 -04:00

tutorial.rst

Rename point2<T> to point<T> (#155 )

2018-10-19 09:32:23 +02:00

README.md

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