📚 Add RTD documentation

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+python:
+  version: 3
+  install:
+      - method: pip
+        path: .
+        extra_requirements:
+          - rtd
+
+sphinx:
+  builder: html
+  fail_on_warning: true

docs/conf.py

@@ -0,0 +1,8 @@
+master_doc = "index"
+project = "sphinxext-rediraffe"
+
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+extensions = ["myst_parser", "sphinxext.rediraffe"]
+
+rediraffe_redirects = {"other.md": "index.md", "other2.md": "other.md"}

docs/index.md

@@ -0,0 +1,3 @@
+```{include} ../README.md
+:relative-images:
+```

setup.py

@@ -22,8 +22,9 @@
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/wpilibsuite/rediraffe",
-    install_requires=["sphinx>=2.0"],
     packages=["sphinxext"],
+    install_requires=["sphinx>=2.0"],
+    extras_require={"rtd": ["myst-parser~=0.12.7"]},
     classifiers=[
         "Environment :: Plugins",
         "Environment :: Web Environment",

tox.ini

@@ -17,3 +17,10 @@ envlist = py{36,37,38}
 ; recreate = false
 deps = -rtest-requirements.txt
 commands = pytest {posargs}
+
+[testenv:docs-{clean,update}]
+extras = rtd
+whitelist_externals = rm
+commands =
+    clean: rm -rf docs/_build
+    sphinx-build {posargs} -nW --keep-going -b html docs/ docs/_build/html