Merge pull request #2 from Deric-W/docs

add Documentation

Author: Deric-W

.readthedocs.yaml

@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.10"
+
+formats:
+  - pdf
+  - epub
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

README.md

@@ -2,15 +2,18 @@
 
 ![Tests](https://github.com/Deric-W/lambda_calculus/actions/workflows/Tests.yaml/badge.svg)
 [![codecov](https://codecov.io/gh/Deric-W/lambda_calculus/branch/main/graph/badge.svg?token=SU3982mC17)](https://codecov.io/gh/Deric-W/lambda_calculus)
+[![Documentation Status](https://readthedocs.org/projects/lambda-calculus/badge/?version=stable)](https://lambda-calculus.readthedocs.io/en/stable/?badge=stable)
 
-The `lambda_calculus` package contains classes which implement basic operations of the lambda calculus.
+The [`lambda_calculus`](https://pypi.org/project/lambda-calculus/) package contains classes which implement basic operations of the lambda calculus.
 
 To use it, simply import the classes `Variable`, `Abstraction` and `Application` from this package
 and nest them to create more complex lambda terms.
 
 You can also use the `visitors` subpackage to define your own operations on terms or
 use predefined ones from the `terms` subpackage.
 
+More information is available on [Read the Docs](https://lambda-calculus.readthedocs.io/).
+
 ## Notice
 
 This package is intended to be used for educational purposes and is not optimized for speed.

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)

docs/api.rst

@@ -0,0 +1,23 @@
+Package API
+===========
+
+.. toctree::
+   :maxdepth: 2
+
+   api/terms
+   api/visitors
+   api/errors
+
+.. automodule:: lambda_calculus
+
+    .. autoclass:: Variable
+
+        Reference to :class:`.terms.Variable` for convenience
+
+    .. autoclass:: Abstraction
+
+        Reference to :class:`.terms.Abstraction` for convenience
+
+    .. autoclass:: Application
+
+        Reference to :class:`.terms.Application` for convenience

docs/api/errors.rst

@@ -0,0 +1,8 @@
+Module errors
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: lambda_calculus.errors
+    :members:

docs/api/terms.rst

@@ -0,0 +1,14 @@
+Package terms
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   terms/logic
+   terms/arithmetic
+   terms/pairs
+   terms/combinators
+
+.. automodule:: lambda_calculus.terms
+    :members:
+    :special-members: __iter__, __str__

docs/api/terms/arithmetic.rst

@@ -0,0 +1,8 @@
+Module arithmetic
+=================
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: lambda_calculus.terms.arithmetic
+    :members:

docs/api/terms/combinators.rst

@@ -0,0 +1,8 @@
+Module combinators
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: lambda_calculus.terms.combinators
+    :members:

docs/api/terms/logic.rst

@@ -0,0 +1,8 @@
+Module logic
+============
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: lambda_calculus.terms.logic
+    :members:

docs/api/terms/pairs.rst

@@ -0,0 +1,8 @@
+Module pairs
+============
+
+.. toctree::
+   :maxdepth: 2
+
+.. automodule:: lambda_calculus.terms.pairs
+    :members: