Imported Upstream version 1.72.0
[platform/upstream/boost.git] / libs / gil / doc / README.md
index 72368cd..48ac0b3 100644 (file)
@@ -4,26 +4,31 @@ A simple guide about writing and building documentation for Boost.GIL.
 
 ## Prerequisites
 
-- Python 3.4+
-- [Install Sphinx](#install-sphinx)
+- 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
 
-TODO
\ No newline at end of file
+```console
+$ echo "using doxygen ;" > ~/user-config.jam
+$ cd boost-root
+$ b2 libs/gil/doc
+```