diff --git a/docs/index.md b/docs/index.md index 3c3fdac..050b34c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,8 @@ # pystapi + +**pystapi** is the Python [monorepo](https://en.wikipedia.org/wiki/Monorepo) for the Satellite Tasking API (STAPI) specification. +It contains three Python packages: + +- [stapi-pydantic](./stapi-pydantic.md): [Pydantic](https://docs.pydantic.dev) models that define the data structures in the STAPI specification +- [stapi-fastapi](./stapi-fastapi.md): [FastAPI](https://fastapi.tiangolo.com/) routes and functions for building a STAPI server +- [pystapi-client](./pystapi-client.md): a Python package and command-line interface (CLI) for interacting with a STAPI server diff --git a/docs/pystapi-client.md b/docs/pystapi-client.md new file mode 100644 index 0000000..9827146 --- /dev/null +++ b/docs/pystapi-client.md @@ -0,0 +1,7 @@ +# pystapi-client + +A Python client for working with [STAPI](https://stapi-spec.github.io/pystapi/) servers. + +## API + +::: pystapi_client diff --git a/docs/pystapi-client/api.md b/docs/pystapi-client/api.md deleted file mode 100644 index 784d5e2..0000000 --- a/docs/pystapi-client/api.md +++ /dev/null @@ -1,3 +0,0 @@ -# API - -::: pystapi-client diff --git a/docs/pystapi-client/index.md b/docs/pystapi-client/index.md deleted file mode 100644 index 6a394b4..0000000 --- a/docs/pystapi-client/index.md +++ /dev/null @@ -1 +0,0 @@ -# pystapi-client diff --git a/docs/stapi-fastapi.md b/docs/stapi-fastapi.md new file mode 100644 index 0000000..08ddbf2 --- /dev/null +++ b/docs/stapi-fastapi.md @@ -0,0 +1,7 @@ +# stapi-fastapi + +[FastAPI](https://fastapi.tiangolo.com/) routes and functions for building a STAPI server. + +## API + +::: stapi_fastapi diff --git a/docs/stapi-pydantic/index.md b/docs/stapi-pydantic.md similarity index 67% rename from docs/stapi-pydantic/index.md rename to docs/stapi-pydantic.md index d215d77..1a6648b 100644 --- a/docs/stapi-pydantic/index.md +++ b/docs/stapi-pydantic.md @@ -4,5 +4,9 @@ !!! note - This repository intentionally has no input/output (IO) functionality. - For making requests to a STAPI API, use **[pystapi-client](../pystapi-client/index.md)**. + This package has no input/output (IO) functionality. + For making requests to a STAPI API, use **[pystapi-client](./pystapi-client.md)**. + +## API + +::: stapi_pydantic diff --git a/docs/stapi-pydantic/api.md b/docs/stapi-pydantic/api.md deleted file mode 100644 index 383cb61..0000000 --- a/docs/stapi-pydantic/api.md +++ /dev/null @@ -1,3 +0,0 @@ -# API - -::: stapi_pydantic diff --git a/mkdocs.yml b/mkdocs.yml index 0fc7be9..f3cb530 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,24 @@ repo_url: https://github.com/stapi-spec/pystapi/ repo_name: pystapi theme: name: material + palette: + - media: "(prefers-color-scheme)" + primary: blue + toggle: + icon: material/brightness-auto + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: blue + toggle: + icon: material/brightness-4 + name: Switch to system preference logo: img/stapi.png favicon: img/stapi.png features: @@ -11,21 +29,15 @@ theme: nav: - index.md - - pystapi-client: - - pystapi-client/index.md - - pystapi-client/api.md - - stapi-pydantic: - - stapi-pydantic/index.md - - stapi-pydantic/api.md + - stapi-pydantic.md + - stapi-fastapi.md + - pystapi-client.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