sphinx docs working draft

Author: William Grant

docs/.gitignore

@@ -0,0 +1 @@
+_build/

docs/Makefile

@@ -0,0 +1,29 @@
+# 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
+
+show:
+	@echo "Showing generated html"
+
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+
+# make sure to rebuild API reference with
+#sphinx-apidoc -o . ../typed_python -f
+# if required
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,34 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+
+project = 'typed_python'
+copyright = '2022, Braxton McKee'
+author = 'Braxton McKee'
+release = '0.2.6'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser',
+              'sphinx.ext.autodoc',
+              'sphinx.ext.napoleon',
+              'sphinx.ext.viewcode'
+              ]
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+sys.path.insert(0, os.path.abspath('..'))

docs/index.rst

@@ -0,0 +1,28 @@
+.. typed_python documentation master file, created by
+
+   sphinx-quickstart on Tue Sep 20 12:56:07 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to typed_python's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction.md
+   intro_2.md
+   modules
+
+This is some stub documentation, which will one day be an API reference + a User Guide/Zoo + Developer's Guide.
+
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/typed_python.md renamed to docs/intro_2.md

@@ -1,4 +1,4 @@
-## Typed Python
+# Typed Python
 
 `typed_python` is a library for describing strongly and semi-strongly typed
 data-structures in Python. `typed_python` types look and feel like their
@@ -19,6 +19,8 @@ It's important to note that `typed_python` is a Python module, not a separate
 Python implementation. This means you can use it as much or as little as you
 want in a project without affecting other code.
 
+## Type Annotations
+
 ### Container Types
 
 Each core python type (`set`, `list`, `dict`, `tuple`) has a corresponding