Skip to content

Commit

Permalink
doc/README.md: clarify steps building docs [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
mloskot committed Nov 4, 2019
1 parent e2c26ce commit cb5b2e0
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,31 @@ A simple guide about writing and building documentation for Boost.GIL.

## Prerequisites

- Python 3.6+
- [Install Sphinx](#install-sphinx) 1.7.9+
- Python 3
- [Install Sphinx](#install-sphinx) (see `requirements.txt`)
- Install [Doxygen](http://www.doxygen.org)


## Installation

Create Python virtual environment:

```console
$ cd boost/libs/gil
$ python3 -m venv .venv
$ source ./.venv/bin/activate
$ source ~/.venv/bin/activate
```

Install Sphinx and Sphinx extensions:

```console
(.venv)$ pip install -r doc/requirements.txt
(.venv)$ cd boost-root
(.venv)$ pip install -r libs/gil/doc/requirements.txt
```

## Build

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

0 comments on commit cb5b2e0

Please sign in to comment.