Adding documentation (Sphinx) and docstrings

.gitignore

@@ -219,4 +219,8 @@ seshat/staticfiles
 pulumi/logs
 pulumi/Pulumi.seshat.yaml
 scripts
-.DS_Store
+.DS_Store
+*.ipynb
+
+docs/source/api/seshat/
+docs/source/api/custom_filters/

README.md

@@ -6,7 +6,15 @@ This repo contains the necessary Django Python code to host the [Seshat](http://
 
 ## Developers
 
-Follow the steps on [docs/setup](docs/setup.md).
+Follow the instructions available in [docs/source/getting-started/setup/index.rst](docs/source/getting-started/setup/index.rst).
+
+In order to generate the documentation, in the correct environment run the following command:
+
+```bash
+pip install -r docs/requirements.txt
+cd docs
+make html
+```
 
 ## GitHub process
 
@@ -22,4 +30,4 @@ Follow the steps on [docs/setup](docs/setup.md).
 On this fork, currently GH actions is set up to run django tests for the following apps when pushing or PR-ing to the `dev` branch:
 - Core
 
-See [docs/testing](docs/testing.md) on how to run locally.
+See [docs/source/contribute/testing.rst](docs/source/contribute/testing.rst) on how to run locally.

docs/Makefile

@@ -0,0 +1,20 @@
+# 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
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.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.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,14 @@
+docstr-coverage
+myst-parser
+nbsphinx
+pandoc
+sphinx
+sphinx_togglebutton
+sphinx-autoapi
+sphinx-autoapi
+sphinx-book-theme
+sphinx-copybutton
+sphinx-tabs
+sphinx-togglebutton
+sphinxcontrib-napoleon
+sphinx-rtd-theme