Skip to content

Commit 18e60b6

Browse files
authored
docs: clean up the docs a bit (#93)
1 parent f655ca2 commit 18e60b6

File tree

8 files changed

+48
-18
lines changed

8 files changed

+48
-18
lines changed

docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,8 @@
11
# pystapi
2+
3+
**pystapi** is the Python [monorepo](https://en.wikipedia.org/wiki/Monorepo) for the Satellite Tasking API (STAPI) specification.
4+
It contains three Python packages:
5+
6+
- [stapi-pydantic](./stapi-pydantic.md): [Pydantic](https://docs.pydantic.dev) models that define the data structures in the STAPI specification
7+
- [stapi-fastapi](./stapi-fastapi.md): [FastAPI](https://fastapi.tiangolo.com/) routes and functions for building a STAPI server
8+
- [pystapi-client](./pystapi-client.md): a Python package and command-line interface (CLI) for interacting with a STAPI server

docs/pystapi-client.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# pystapi-client
2+
3+
A Python client for working with [STAPI](https://stapi-spec.github.io/pystapi/) servers.
4+
5+
## API
6+
7+
::: pystapi_client

docs/pystapi-client/api.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/pystapi-client/index.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/stapi-fastapi.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# stapi-fastapi
2+
3+
[FastAPI](https://fastapi.tiangolo.com/) routes and functions for building a STAPI server.
4+
5+
## API
6+
7+
::: stapi_fastapi
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,9 @@
44

55
!!! note
66

7-
This repository intentionally has no input/output (IO) functionality.
8-
For making requests to a STAPI API, use **[pystapi-client](../pystapi-client/index.md)**.
7+
This package has no input/output (IO) functionality.
8+
For making requests to a STAPI API, use **[pystapi-client](./pystapi-client.md)**.
9+
10+
## API
11+
12+
::: stapi_pydantic

docs/stapi-pydantic/api.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

mkdocs.yml

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,40 @@ repo_url: https://github.com/stapi-spec/pystapi/
44
repo_name: pystapi
55
theme:
66
name: material
7+
palette:
8+
- media: "(prefers-color-scheme)"
9+
primary: blue
10+
toggle:
11+
icon: material/brightness-auto
12+
name: Switch to light mode
13+
- media: "(prefers-color-scheme: light)"
14+
scheme: default
15+
primary: blue
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
- media: "(prefers-color-scheme: dark)"
20+
scheme: slate
21+
primary: blue
22+
toggle:
23+
icon: material/brightness-4
24+
name: Switch to system preference
725
logo: img/stapi.png
826
favicon: img/stapi.png
927
features:
1028
- navigation.indexes
1129

1230
nav:
1331
- index.md
14-
- pystapi-client:
15-
- pystapi-client/index.md
16-
- pystapi-client/api.md
17-
- stapi-pydantic:
18-
- stapi-pydantic/index.md
19-
- stapi-pydantic/api.md
32+
- stapi-pydantic.md
33+
- stapi-fastapi.md
34+
- pystapi-client.md
2035

2136
plugins:
2237
- mkdocstrings:
2338
default_handler: python
2439
handlers:
2540
python:
26-
options:
27-
show_if_no_docstring: true
28-
show_submodules: true
2941
inventories:
3042
- https://docs.python.org/3/objects.inv
3143
- https://docs.pydantic.dev/latest/objects.inv

0 commit comments

Comments
 (0)