Create initial package documentation

.github/workflows/release.yml

@@ -8,14 +8,14 @@ on:
 
 jobs:
   check-manifest:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - uses: pre-commit/action@v3.0.1
         with:
@@ -24,7 +24,7 @@ jobs:
   build-package:
     needs: check-manifest
     name: Build package
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout
@@ -53,7 +53,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, macOS-14, windows-2022]
+        os: [ubuntu-22.04, macOS-14, windows-2022]
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
@@ -97,7 +97,7 @@ jobs:
   upload-wheels:
     name: Upload wheels to PyPI
     needs: test-wheels
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/download-artifact@v4

CONTRIBUTORS.md

@@ -0,0 +1,18 @@
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg)](#contributors)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+This project welcomes contributions of all kinds and follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification to recognize them.
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->

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     = 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)

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

docs/source/_static/class.rst

@@ -0,0 +1,10 @@
+{{objname}}
+{{ underline }}==============
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+
+.. raw:: html
+
+    <div class="clearer"></div>

docs/source/_static/class_with_call.rst

@@ -0,0 +1,11 @@
+{{objname}}
+{{ underline }}===============
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :special-members: __call__
+
+.. raw:: html
+
+    <div class="clearer"></div>

docs/source/_static/function.rst

@@ -0,0 +1,10 @@
+{{objname}}
+{{ underline }}====================
+
+.. currentmodule:: {{ module }}
+
+.. autofunction:: {{ objname }}
+
+.. raw:: html
+
+    <div class="clearer"></div>

docs/source/_static/switcher.json

@@ -0,0 +1,12 @@
+[
+    {
+        "name": "dev",
+        "version": "latest",
+        "url": "https://predictably.readthedocs.io/en/latest/"
+    },
+    {
+        "name": "0.2.0 (stable)",
+        "version": "stable",
+        "url": "https://predictably.readthedocs.io/en/v0.2.0/"
+    }
+]

docs/source/about.rst

@@ -0,0 +1,47 @@
+.. _top_level_about:
+
+=====
+About
+=====
+
+Learn more about the ``predictably_core`` project and its community.
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   about/overview
+   about/contributors
+   about/governance
+   about/roadmap
+
+.. grid:: 1 2 2 2
+    :gutter: 3
+
+    .. grid-item-card:: Overview
+        :text-align: left
+        :link: about/overview
+        :link-type: doc
+
+        Learn more about ``predictably_core``.
+
+    .. grid-item-card:: Contributors
+        :text-align: left
+        :link: about/contributors
+        :link-type: doc
+
+        All of ``predictably_core``'s contributors.
+
+    .. grid-item-card:: Governance
+        :text-align: left
+        :link: about/governance
+        :link-type: doc
+
+        How we govern the project.
+
+    .. grid-item-card:: Roadmap
+        :text-align: left
+        :link: about/roadmap
+        :link-type: doc
+
+        Where we plan to take ``predictably_core``.

docs/source/about/contributors.md

@@ -0,0 +1,2 @@
+```{include} ../../../CONTRIBUTORS.md
+```