From 812462fc47210b69ee54856825419714032b53da Mon Sep 17 00:00:00 2001 From: Matthias Wolf Date: Mon, 8 Jul 2024 10:19:36 +0200 Subject: [PATCH] Add documentation via readthedocs. --- .readthedocs.yaml | 16 ++++++++++++++++ {doc => docs}/Makefile | 0 {doc => docs}/source/_static/banner.jpg | Bin {doc => docs}/source/api.rst | 0 {doc => docs}/source/changes.rst | 0 {doc => docs}/source/conf.py | 0 {doc => docs}/source/debugging.rst | 0 {doc => docs}/source/disk_scaling.png | Bin {doc => docs}/source/filters.rst | 0 {doc => docs}/source/index.rst | 0 {doc => docs}/source/license.rst | 0 docs/source/requirements.txt | 3 +++ {doc => docs}/source/usage.rst | 0 tox.ini | 6 ++---- 14 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 .readthedocs.yaml rename {doc => docs}/Makefile (100%) rename {doc => docs}/source/_static/banner.jpg (100%) rename {doc => docs}/source/api.rst (100%) rename {doc => docs}/source/changes.rst (100%) rename {doc => docs}/source/conf.py (100%) rename {doc => docs}/source/debugging.rst (100%) rename {doc => docs}/source/disk_scaling.png (100%) rename {doc => docs}/source/filters.rst (100%) rename {doc => docs}/source/index.rst (100%) rename {doc => docs}/source/license.rst (100%) create mode 100644 docs/source/requirements.txt rename {doc => docs}/source/usage.rst (100%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..796fca2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,16 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + jobs: + post_checkout: + - git submodule update --init + +sphinx: + configuration: docs/source/conf.py + +python: + install: + - requirements: docs/source/requirements.txt diff --git a/doc/Makefile b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/source/_static/banner.jpg b/docs/source/_static/banner.jpg similarity index 100% rename from doc/source/_static/banner.jpg rename to docs/source/_static/banner.jpg diff --git a/doc/source/api.rst b/docs/source/api.rst similarity index 100% rename from doc/source/api.rst rename to docs/source/api.rst diff --git a/doc/source/changes.rst b/docs/source/changes.rst similarity index 100% rename from doc/source/changes.rst rename to docs/source/changes.rst diff --git a/doc/source/conf.py b/docs/source/conf.py similarity index 100% rename from doc/source/conf.py rename to docs/source/conf.py diff --git a/doc/source/debugging.rst b/docs/source/debugging.rst similarity index 100% rename from doc/source/debugging.rst rename to docs/source/debugging.rst diff --git a/doc/source/disk_scaling.png b/docs/source/disk_scaling.png similarity index 100% rename from doc/source/disk_scaling.png rename to docs/source/disk_scaling.png diff --git a/doc/source/filters.rst b/docs/source/filters.rst similarity index 100% rename from doc/source/filters.rst rename to docs/source/filters.rst diff --git a/doc/source/index.rst b/docs/source/index.rst similarity index 100% rename from doc/source/index.rst rename to docs/source/index.rst diff --git a/doc/source/license.rst b/docs/source/license.rst similarity index 100% rename from doc/source/license.rst rename to docs/source/license.rst diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt new file mode 100644 index 0000000..174a0bb --- /dev/null +++ b/docs/source/requirements.txt @@ -0,0 +1,3 @@ +mock +sphinx +sphinx-bluebrain-theme diff --git a/doc/source/usage.rst b/docs/source/usage.rst similarity index 100% rename from doc/source/usage.rst rename to docs/source/usage.rst diff --git a/tox.ini b/tox.ini index 2facc54..f3c8ef5 100644 --- 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