chore: add readthedoc support (0b01001001#315)

Signed-off-by: Keming <kemingy94@gmail.com>

.readthedocs.yaml

@@ -0,0 +1,25 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - method: pip
+    path: .
+    extra_requirements:
+    - docs

Makefile

@@ -21,7 +21,7 @@ doc:
 	cd docs && make html
 
 opendoc:
-	cd docs/build/html && python -m http.server
+	cd docs/build/html && python -m http.server 8765
 
 clean:
 	rm -rf build/ dist/ *.egg-info .pytest_cache

docs/source/index.rst

@@ -3,6 +3,10 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+.. meta::
+    :description lang=en:
+        SpecTree is an API spec validator and OpenAPI document generator for Python web frameworks.
+
 Welcome to spectree's documentation!
 ====================================
 

setup.py

@@ -23,5 +23,9 @@
             "mypy>=0.971",
             "syrupy>=4.0.0",
         ],
+        "docs": [
+            "Sphinx",
+            "furo",
+        ],
     },
 )