Generated Documentation with Sphinx

Answering UCL UCL-RITS#101
rmapjs1 · Jan 6, 2021 · 1359489 · 1359489
1 parent c04791f
commit 1359489
Show file tree

Hide file tree

Showing 33 changed files with 15,497 additions and 0 deletions.
diff --git a/week06/average-squares-example/docs/Makefile b/week06/average-squares-example/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     = .
+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)
diff --git a/week06/average-squares-example/docs/_build/html/.buildinfo b/week06/average-squares-example/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 16c8507efed606145d536f496f3498e8
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/...6/average-squares-example/docs/_build/html/.doctrees/content/average-squares-docs.doctree b/...6/average-squares-example/docs/_build/html/.doctrees/content/average-squares-docs.doctree
diff --git a/week06/average-squares-example/docs/_build/html/.doctrees/environment.pickle b/week06/average-squares-example/docs/_build/html/.doctrees/environment.pickle
diff --git a/week06/average-squares-example/docs/_build/html/.doctrees/index.doctree b/week06/average-squares-example/docs/_build/html/.doctrees/index.doctree
diff --git a/...-squares-example/docs/_build/html/_sources/content/average-squares-docs.rst.txt b/...-squares-example/docs/_build/html/_sources/content/average-squares-docs.rst.txt
@@ -0,0 +1,5 @@
+Average Squares Documentation
+=============================
+
+.. automodule:: squares
+    :members:
diff --git a/week06/average-squares-example/docs/_build/html/_sources/index.rst.txt b/week06/average-squares-example/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,25 @@
+.. generating_documentation_with_sphinx documentation master file, created by
+   sphinx-quickstart on Wed Jan  6 22:57:39 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to generating_documentation_with_sphinx's documentation!
+================================================================
+
+The purpose of this project is to learn how to write documentation using Sphinx.
+The documentation will be on UCL issue #100.
+The instructions for how this documentation was created are found in UCL issue #101.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   content/average-squares-docs.rst
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`