Set up readthedocs (#31)

* set up readthedocs * fix typo and broken link * remove sphinx _templates folder
pymc-devs · Mar 18, 2022 · 2343803 · 2343803
1 parent 576931b
commit 2343803
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 221 deletions.
diff --git a/.github/workflows/publish-docs-release.yml b/.github/workflows/publish-docs-release.yml
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,15 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+python:
+   install:
+   - requirements: requirements-docs.txt
+   - requirements: requirements.txt
+   - method: pip
+     path: .
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing guide
+
+Page in construction, for now go to https://github.com/pymc-devs/pymc-experimental#questions.
diff --git a/docs/_templates/versioning.html b/docs/_templates/versioning.html
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,15 +46,12 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.mathjax",
     "nbsphinx",
-    "sphinx_multiversion",
 ]
 
 nbsphinx_execute = "never"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-html_sidebars = {"**": ["searchbox.html", "versioning.html"]}
+# templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -113,32 +110,6 @@
 # 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 = {}
-
-# Whitelist pattern for remotes (set to None to use local branches only)
-smv_remote_whitelist = r"^origin$"
-
-# Whitelist pattern for branches (set to None to ignore all branches)
-smv_branch_whitelist = r"^main$"
-
-# Tags are released
-smv_released_pattern = r"^refs/tags/.*$"
-
-# Tags like 0.0.1, 0.5.1 are kept
-# smv_tag_whitelist = r'^\d+\.\d+\.\d+S'
-
-# sphinx-multiversion options
-smv_rebuild_tags = False
-smv_tag_whitelist = r"^\d+\.\d+.\d+$"
-
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.

diff --git a/docs/index.rst b/docs/index.rst
@@ -28,8 +28,7 @@ Installation
 
 .. code-block:: bash
 
-   pip install git+https://github.com/pymc-devs/pymc_experimental.git
-
+  pip install git+https://github.com/pymc-devs/pymc-experimental.git
 
 Contributing
 ============

diff --git a/requirements-dev.txt b/requirements-dev.txt
diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -0,0 +1,3 @@
+nbsphinx>=0.4.2
+pydata-sphinx-theme>=0.6.3
+sphinx>=4