Add documentation via readthedocs.

BlueBrain · Jul 8, 2024 · 5e68b2c · 5e68b2c
1 parent fe55b29
commit 5e68b2c
Show file tree

Hide file tree

Showing 14 changed files with 25 additions and 4 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_checkout:
+      - git submodule update --init
+    post_install:
+      - wget -qO- https://boostorg.jfrog.io/artifactory/main/release/1.85.0/source/boost_1_85_0.tar.bz2 | tar xjf -
+      - cd boost_1_85_0 && ./bootstrap.sh && ./b2 --prefix=../boost --with-serialization --with-filesystem --with-test install
+      - env CMAKE_PREFIX_PATH=boost SKBUILD_CMAKE_DEFINE="CMAKE_INSTALL_RPATH=$PWD/boost/lib;SI_MPI=OFF" pip install .
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+   install:
+   - requirements: docs/source/requirements.txt
diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/source/_static/banner.jpg → docs/source/_static/banner.jpg b/doc/source/_static/banner.jpg → docs/source/_static/banner.jpg
diff --git a/doc/source/api.rst → docs/source/api.rst b/doc/source/api.rst → docs/source/api.rst
diff --git a/doc/source/changes.rst → docs/source/changes.rst b/doc/source/changes.rst → docs/source/changes.rst
diff --git a/doc/source/conf.py → docs/source/conf.py b/doc/source/conf.py → docs/source/conf.py
diff --git a/doc/source/debugging.rst → docs/source/debugging.rst b/doc/source/debugging.rst → docs/source/debugging.rst
diff --git a/doc/source/disk_scaling.png → docs/source/disk_scaling.png b/doc/source/disk_scaling.png → docs/source/disk_scaling.png
diff --git a/doc/source/filters.rst → docs/source/filters.rst b/doc/source/filters.rst → docs/source/filters.rst
diff --git a/doc/source/index.rst → docs/source/index.rst b/doc/source/index.rst → docs/source/index.rst
diff --git a/doc/source/license.rst → docs/source/license.rst b/doc/source/license.rst → docs/source/license.rst
diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -0,0 +1,3 @@
+mock
+sphinx
+sphinx-bluebrain-theme
diff --git a/doc/source/usage.rst → docs/source/usage.rst b/doc/source/usage.rst → docs/source/usage.rst
diff --git a/tox.ini b/tox.ini
@@ -33,10 +33,8 @@ commands =
     ruff format --check
 
 [testenv:docs]
-changedir = doc
-deps =
-    sphinx
-    sphinx-bluebrain-theme
+changedir = docs
+dep_file = docs/source/requirements.txt
 # set warnings as errors using the -W sphinx option
 commands = make html SPHINXOPTS=-W
 allowlist_externals = make