boost/gil

mirror of https://github.com/boostorg/gil.git synced 2026-01-29 07:32:18 +00:00

Files

Mateusz Łoskot 5ec5566fe4 [doc] Removed unused files (#327 ) [ci skip]

The following files have been deleted:

- doc/adobe_logo.gif
- doc/adobe_source.css
- doc/boost.png
- doc/build.sh
- doc/rst.css
- doc/shorten_file_name.sh

2019-07-09 09:45:18 +02:00

_static

Update documentation.

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

_templates

Update documentation.

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

doxygen

Remove doc/doxygen/design_guide.dox as old docs remains (#285 )

2019-04-15 23:16:11 +02:00

images

Update documentation.

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

conf.py

Fix Sphinx warnig about html_add_permalinks type [ci skip]

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

design_guide.rst

[doc] Fix incomplete code-block directive [skip appveyor]

2019-07-08 19:08:26 +02:00

doxyfile

Update INPUT list in doc/doxyfile (#254 )

2019-03-07 14:40:28 +01: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

Move tests of extensions inside test/ directory (#302 )

2019-05-28 18:58:22 +02:00

Jamfile

Restore copyright notice removed by accident [ci skip]

2019-05-21 11:31:53 +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

Add documentation build steps to doc/README.md

2019-07-08 18:09:35 +02: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

toolbox.rst

Tidy up, some doc8 linting, tabs to spaces.

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

tutorial.rst

Replace BOOST_STATIC_CONSTANT with constexpr (#211 )

2019-01-12 23:57:35 +01:00

README.md

Boost.GIL Documentation

A simple guide about writing and building documentation for Boost.GIL.

Prerequisites

Python 3.6+
Install Sphinx 1.7.9+
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

$ echo "using doxygen ;" > ~/user-config.jam
$ cd boost/libs/gil/doc
$ b2