Doctest setup

.readthedocs.yaml

@@ -13,3 +13,7 @@ python:
    - requirements: requirements.txt
    - method: pip
      path: .
+
+sphinx:
+  fail_on_warning: false
+  configuration: docs/source/conf.py

docs/Makefile

@@ -2,9 +2,9 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = # "-W" treats warnings as errors
-SPHINXBUILD   ?= sphinx-multiversion
-SOURCEDIR     = .
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
 BUILDDIR      ?= _build
 
 # Put it first so that "make" without argument is like "make help".
@@ -24,3 +24,8 @@ local:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(SOURCEDIR) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+		"results in $(BUILDDIR)/doctest/output.txt"

docs/conf.py → docs/source/conf.py

@@ -56,6 +56,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
@@ -127,7 +128,7 @@
 # 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"]
+html_static_path = ["../_static"]
 
 # -- Options for HTMLHelp output ---------------------------------------------
 

docs/source/index.rst

@@ -0,0 +1,44 @@
+PyMC experimental
+===================================================
+|Tests|
+|Coverage|
+|Black|
+
+
+.. |Tests| image:: https://github.com/pymc-devs/pymc-experimental/actions/workflows/test.yml/badge.svg
+    :target: https://github.com/pymc-devs/pymc-experimental
+
+.. |Coverage| image:: https://codecov.io/gh/pymc-devs/pymc-experimental/branch/main/graph/badge.svg?token=ZqH0KCLKAE
+    :target: https://codecov.io/gh/pymc-devs/pymc-experimental
+
+.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
+
+
+
+Where we grow the next batch of cool PyMC features
+
+
+Dependencies
+============
+PyMC experimental is tested on Python 3.8+ and depends on PyMC V5.
+
+Installation
+============
+
+.. code-block:: bash
+
+  pip install git+https://github.com/pymc-devs/pymc-experimental.git
+
+Contributing
+============
+We welcome contributions from interested individuals or groups! For information about contributing to PyMC experimental check out our instructions, policies, and guidelines `here <https://github.com/pymc-devs/pymc-experimental/blob/main/CONTRIBUTING.md>`_.
+
+Contributors
+============
+See the `GitHub contributor page <https://github.com/pymc-devs/pymc-experimental/graphs/contributors>`_.
+
+.. toctree::
+   :hidden:
+
+   api_reference <https://www.pymc.io/projects/experimental/en/latest/api_reference.html>