Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions docs/pystapi-client.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# pystapi-client

A Python client for working with [STAPI](https://stapi-spec.github.io/pystapi/) servers.

## API

::: pystapi_client
3 changes: 0 additions & 3 deletions docs/pystapi-client/api.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/pystapi-client/index.md

This file was deleted.

7 changes: 7 additions & 0 deletions docs/stapi-fastapi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# stapi-fastapi

[FastAPI](https://fastapi.tiangolo.com/) routes and functions for building a STAPI server.

## API

::: stapi_fastapi
8 changes: 6 additions & 2 deletions docs/stapi-pydantic/index.md → docs/stapi-pydantic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 0 additions & 3 deletions docs/stapi-pydantic/api.md

This file was deleted.

30 changes: 21 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,40 @@ 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:
- navigation.indexes

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
Expand Down