Migrate to ReadTheDocs

FrancisCrickInstitute · Feb 16, 2024 · 1495f0d · 1495f0d
1 parent 6a60571
commit 1495f0d
Show file tree

Hide file tree

Showing 52 changed files with 190 additions and 23,395 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: "2"
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/source/conf.py
diff --git a/Doxyfile b/Doxyfile
diff --git a/docs/.buildinfo b/docs/.buildinfo
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/sphinx/Makefile → docs/Makefile b/sphinx/Makefile → docs/Makefile
@@ -1,30 +1,21 @@
-# *** Makefile is ONLY USED ON macOS or Linux with (GNU) ***
-# *** On Windows only make.bat is used ***
-
 # Minimal makefile for Sphinx documentation
 #
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
+SPHINXPROJ    = OmeSliCC
 SOURCEDIR     = .
-BUILDDIR      = _build
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	@echo "  docs       to make github docs"
 
-.PHONY: help Makefile docs
+.PHONY: help Makefile
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-docs:
-	make html
-	rm -rf docs
-	cp -r $(BUILDDIR)/html docs
-	touch docs/.nojekyll
diff --git a/docs/_static/_sphinx_javascript_frameworks_compat.js b/docs/_static/_sphinx_javascript_frameworks_compat.js