Merge pull request #66 from quant-aq/dhhagan-docs

Updated docs to include google-ish formatted docstrings and improved guides

Author: dhhagan

.github/workflows/docs.yml

@@ -30,7 +30,6 @@ jobs:
                 source .venv/bin/activate 
                 cd docs
                 make clean
-                make guides
                 make html
                 cd ..
 

.github/workflows/test-and-report.yml

@@ -1,4 +1,4 @@
-name: run tests and report results
+name: ci.tests
 on: [pull_request, workflow_dispatch]
 jobs:
     tests:

README.md

@@ -0,0 +1,24 @@
+# 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     = .
+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)
+
+.PHONY: guides
+guides:
+	make -C guides/