Setup readthedocs

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.8
+   install:
+   - requirements: docs/requirements.txt

docs/conf.py

@@ -64,7 +64,7 @@
 #
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    "github_url": "https://github.com/numpy/numpydoc",
+    "github_url": "https://github.com/mggg/maup",
     "show_prev_next": False,
     "navbar_end": ["search-field.html", "navbar-icon-links.html"],
 }

docs/index.rst

@@ -23,7 +23,7 @@ districts, such as
 Quick help:
 
 - `Example usage <https://github.com/mggg/maup#readme>`_
-- `Best practice guidelines <https://github.com/mggg/maup/blob/main/best-practices.md>`_ 
+- `Best practice guidelines <https://github.com/mggg/maup/blob/master/best-practices.md>`_ 
 - `API reference </reference/api/maup.html>`_