docs: host on readthedocs

fhchl · Jan 31, 2024 · 257a5fb · 257a5fb
1 parent ce4eb68
commit 257a5fb
Show file tree

Hide file tree

Showing 11 changed files with 32 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,7 @@ experiments
 .coverage
 htmlcov
 build
-docs/_build
+docs/source/_build
 docs/generated
 *.pytest_cache
 .pytype

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
@@ -20,4 +20,4 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 livehtml:
-	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,9 @@
+nbsphinx
+sphinx-autobuild
+sphinx-autodoc-typehints
+sphinx
+sphinxcontrib-bibtex
+sphinxcontrib-aafig
+furo
+./
+
diff --git a/docs/source/.gitignore b/docs/source/.gitignore
@@ -0,0 +1 @@
+generated/
diff --git a/docs/api.rst → docs/source/api.rst b/docs/api.rst → docs/source/api.rst
diff --git a/docs/bibliography.bib → docs/source/bibliography.bib b/docs/bibliography.bib → docs/source/bibliography.bib
diff --git a/docs/conf.py → docs/source/conf.py b/docs/conf.py → docs/source/conf.py
@@ -3,6 +3,12 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import os
+import sys
+
+
+sys.path.insert(0, os.path.abspath("../.."))
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 

diff --git a/docs/examples.rst → docs/source/examples.rst b/docs/examples.rst → docs/source/examples.rst
diff --git a/docs/index.rst → docs/source/index.rst b/docs/index.rst → docs/source/index.rst
diff --git a/docs/references.rst → docs/source/references.rst b/docs/references.rst → docs/source/references.rst