Add API docs using Sphinx

.gitignore

@@ -1,5 +1,6 @@
 build/*
 dist/*
+doc/build/*
 *.egg-info
 __pycache__
 .ruff_cache

doc/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+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)
+
+buildapi:
+	sphinx-apidoc -efM ../squigglepy -o source/reference
+	@echo "Auto-generation of API documentation finished. " \
+		"The generated files are in 'api/'"

doc/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
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

doc/source/conf.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "Squigglepy"
+copyright = "2023, Peter Wildeford"
+author = "Peter Wildeford"
+
+# The short X.Y version
+version = ""
+# The full version, including alpha/beta/rc tags
+release = ""
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.imgmath",
+    "sphinx.ext.viewcode",
+    "numpydoc",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "pydata_sphinx_theme"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "Squigglepydoc"
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "Squigglepy.tex", "Squigglepy Documentation", "Peter Wildeford", "manual"),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "squigglepy", "Squigglepy Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "Squigglepy",
+        "Squigglepy Documentation",
+        author,
+        "Squigglepy",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+numpydoc_class_members_toctree = False

doc/source/index.rst

@@ -0,0 +1,51 @@
+Squigglepy: Implementation of Squiggle in Python
+================================================
+
+`Squiggle <https://www.squiggle-language.com/>`__ is a "simple
+programming language for intuitive probabilistic estimation". It serves
+as its own standalone programming language with its own syntax, but it
+is implemented in JavaScript. I like the features of Squiggle and intend
+to use it frequently, but I also sometimes want to use similar
+functionalities in Python, especially alongside other Python statistical
+programming packages like Numpy, Pandas, and Matplotlib. The
+**squigglepy** package here implements many Squiggle-like
+functionalities in Python.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   Installation <installation>
+   Usage <usage>
+   API Reference <reference/modules>
+
+Disclaimers
+-----------
+
+This package is unofficial and supported by Peter Wildeford and Rethink
+Priorities. It is not affiliated with or associated with the Quantified
+Uncertainty Research Institute, which maintains the Squiggle language
+(in JavaScript).
+
+This package is also new and not yet in a stable production version, so
+you may encounter bugs and other errors. Please report those so they can
+be fixed. It’s also possible that future versions of the package may
+introduce breaking changes.
+
+This package is available under an MIT License.
+
+Acknowledgements
+----------------
+
+-  The primary author of this package is Peter Wildeford. Agustín
+   Covarrubias and Bernardo Baron contributed several key features and
+   developments.
+-  Thanks to Ozzie Gooen and the Quantified Uncertainty Research
+   Institute for creating and maintaining the original Squiggle
+   language.
+-  Thanks to Dawn Drescher for helping me implement math between
+   distributions.
+-  Thanks to Dawn Drescher for coming up with the idea to use ``~`` as a
+   shorthand for ``sample``, as well as helping me implement it.
+
+.. autosummary::

doc/source/installation.rst

@@ -0,0 +1,12 @@
+Installation
+============
+
+.. code:: shell
+
+   pip install squigglepy
+
+For plotting support, you can also use the ``plots`` extra:
+
+.. code:: shell
+
+   pip install squigglepy[plots]

doc/source/reference/modules.rst

@@ -0,0 +1,7 @@
+squigglepy
+==========
+
+.. toctree::
+   :maxdepth: 4
+
+   squigglepy

doc/source/reference/squigglepy.bayes.rst

@@ -0,0 +1,7 @@
+squigglepy.bayes module
+=======================
+
+.. automodule:: squigglepy.bayes
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/reference/squigglepy.correlation.rst

@@ -0,0 +1,7 @@
+squigglepy.correlation module
+=============================
+
+.. automodule:: squigglepy.correlation
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/reference/squigglepy.distributions.rst

@@ -0,0 +1,7 @@
+squigglepy.distributions module
+===============================
+
+.. automodule:: squigglepy.distributions
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/reference/squigglepy.numbers.rst

@@ -0,0 +1,7 @@
+squigglepy.numbers module
+=========================
+
+.. automodule:: squigglepy.numbers
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/reference/squigglepy.rng.rst

@@ -0,0 +1,7 @@
+squigglepy.rng module
+=====================
+
+.. automodule:: squigglepy.rng
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/reference/squigglepy.rst

@@ -0,0 +1,22 @@
+squigglepy package
+==================
+
+.. automodule:: squigglepy
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   squigglepy.bayes
+   squigglepy.correlation
+   squigglepy.distributions
+   squigglepy.numbers
+   squigglepy.rng
+   squigglepy.samplers
+   squigglepy.utils
+   squigglepy.version

doc/source/reference/squigglepy.samplers.rst

@@ -0,0 +1,7 @@
+squigglepy.samplers module
+==========================
+
+.. automodule:: squigglepy.samplers
+   :members:
+   :undoc-members:
+   :show-inheritance: