feat: add docs (#9)

Pretty bare-bones for now, but you gotta start somewhere!

Author: gadomski

.github/workflows/ci.yaml

@@ -23,3 +23,19 @@ jobs:
         run: scripts/lint
       - name: Test
         run: uv run pytest
+      - name: Docs
+        run: uv run mkdocs build --strict
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+  docs:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    needs: ci
+    steps:
+      - id: deploy
+        uses: actions/deploy-pages@v4

docs/img/stapi.png

@@ -0,0 +1 @@
+../README.md

docs/index.md

@@ -0,0 +1,3 @@
+# API
+
+::: stapi_pydantic

docs/stapi-pydantic/api.md

@@ -0,0 +1,8 @@
+# stapi-pydantic
+
+[Pydantic](https://docs.pydantic.dev) models for the [Satellite Tasking API (STAPI)](https://github.com/stapi-spec/) specification.
+
+!!! note
+
+    This repository intentionally has no input/output (IO) functionality.
+    For making requests to a STAPI API, use **pystapi-client**.

docs/stapi-pydantic/index.md

@@ -0,0 +1,36 @@
+site_name: pystapi
+site_url: https://stapi-spec.github.io/pystapi
+repo_url: https://github.com/stapi-spec/pystapi/
+repo_name: pystapi
+theme:
+  name: material
+  logo: img/stapi.png
+  favicon: img/stapi.png
+  features:
+    - navigation.indexes
+
+nav:
+  - index.md
+  - stapi-pydantic:
+      - stapi-pydantic/index.md
+      - stapi-pydantic/api.md
+
+plugins:
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          options:
+            show_if_no_docstring: true
+            show_submodules: true
+          inventories:
+            - https://docs.python.org/3/objects.inv
+            - https://docs.pydantic.dev/latest/objects.inv
+
+markdown_extensions:
+  - admonition
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format

mkdocs.yml

@@ -5,7 +5,8 @@ description = "Monorepo for Satellite Tasking API (STAPI) Specification Python p
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = [
-    "stapi-pydantic"
+    "mkdocstrings-python>=1.16.8",
+    "stapi-pydantic",
 ]
 
 [dependency-groups]
@@ -14,6 +15,12 @@ dev = [
     "pytest>=8.3.5",
     "ruff>=0.11.2",
 ]
+docs = [
+    "mkdocs-material>=9.6.11",
+]
+
+[tool.uv]
+default-groups = ["dev", "docs"]
 
 [tool.uv.workspace]
 members = ["stapi-pydantic"]

pyproject.toml

@@ -1 +1,7 @@
 # stapi-pydantic
+
+[Pydantic](https://docs.pydantic.dev) models for the [Satellite Tasking API (STAPI)](https://github.com/stapi-spec/) specification.
+
+> [!NOTE]
+> This repository intentionally has no input/output (IO) functionality.
+> For making requests to a STAPI API, use **pystapi-client**.