From ffc4fcce7935feaa9a9e0ee3c8632deab537fdce Mon Sep 17 00:00:00 2001
From: gcontini <1121667+gcontini@users.noreply.github.com>
Date: 周六, 24 10月 2020 19:44:33 +0800
Subject: [PATCH] sphinx installation

---
 pyvenv.cfg                           |    3 +++
 requirements.txt                     |    8 ++++++++
 doc/development/Build-the-library.md |   22 ++++++++++++++++++++++
 3 files changed, 33 insertions(+), 0 deletions(-)

diff --git a/doc/development/Build-the-library.md b/doc/development/Build-the-library.md
index f36cb2e..aeaee58 100644
--- a/doc/development/Build-the-library.md
+++ b/doc/development/Build-the-library.md
@@ -154,3 +154,25 @@
 cmake -DCMAKE_TOOLCHAIN_FILE=../modules/toolchain-ubuntu-mingw64.cmake -DOPENSSL_ROOT_DIR=$CUR_PATH/openssl-OpenSSL_1_1_1d/dist -DCMAKE_FIND_DEBUG_MODE=ON -DOPENSSL_USE_STATIC_LIBS=ON -DBOOST_ROOT=$CUR_PATH/boost_1_71_0/dist  ..
 
 ```
+
+###Build documentation
+
+Setup the python virtual environment:
+
+```
+python3 -m venv .venv
+
+. .venv/bin/activate
+pip install wheel
+pip install -r requirements.txt
+
+```
+
+Build the docs:
+
+```
+. .venv/bin/activate
+cd build
+cmake ..
+make documentation
+```
\ No newline at end of file
diff --git a/pyvenv.cfg b/pyvenv.cfg
new file mode 100644
index 0000000..8dbc2ba
--- /dev/null
+++ b/pyvenv.cfg
@@ -0,0 +1,3 @@
+home = /usr/bin
+include-system-site-packages = false
+version = 3.8.5
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..d1e0d6e
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,8 @@
+wheel >= 0.35.1
+sphinx >= 3.2.1
+sphinx-rtd-theme >= 0.5.0
+breathe >= 4.23.0
+sphinx-markdown-tables >= 0.0.15
+recommonmark >= 0.6.0 
+sphinx-sitemap >= 2.2.0 
+sphinxemoji >= 0.1.8
\ No newline at end of file

--
Gitblit v1.9.1