Skip to content

Commit ad39294

Browse files
vincentsaragovincentsarago
authored
switch to mkdocstring (#816)
1 parent 82a73b5 commit ad39294

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+394
-117
lines changed

‎.github/workflows/deploy_mkdocs.yml‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,5 @@ jobs:
3333
stac_fastapi/api[docs] \
3434
stac_fastapi/extensions[docs] \
3535
36-
- name: update API docs
37-
run: |
38-
pdocs as_markdown \
39-
--output_dir docs/src/api/ \
40-
--exclude_source \
41-
--overwrite \
42-
stac_fastapi
43-
4436
- name: Deploy docs
4537
run: mkdocs gh-deploy --force -f docs/mkdocs.yml

‎CONTRIBUTING.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ To manually deploy docs (note you should never need to do this because GitHub
3636
Actions deploys automatically for new commits.):
3737

3838
```bash
39-
Create API documentations
40-
$ pdocs as_markdown \
41-
--output_dir docs/src/api/ \
42-
--exclude_source \
43-
--overwrite \
44-
stac_fastapi
45-
4639
# deploy
4740
$ mkdocs gh-deploy -f docs/mkdocs.yml
4841
```

‎Dockerfile.docs‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,14 @@ FROM python:3.11-slim
44
RUN apt update && apt install -y build-essential
55

66
RUN python -m pip install --upgrade pip
7-
RUN python -m pip install mkdocs mkdocs-material pdocs
87

98
COPY . /opt/src
109

1110
WORKDIR /opt/src
1211

1312
RUN python -m pip install \
14-
stac_fastapi/types \
15-
stac_fastapi/api \
16-
stac_fastapi/extensions
13+
"stac_fastapi/types[docs]" \
14+
"stac_fastapi/api[docs]" \
15+
"stac_fastapi/extensions[docs]"
1716

18-
CMD ["pdocs", \
19-
"as_markdown", \
20-
"--output_dir", \
21-
"docs/api/", \
22-
"--exclude_source", \
23-
"--overwrite", \
24-
"stac_fastapi"]
17+
CMD ["mkdocs", "build", "-f", "docs/mkdocs.yml"]

‎docker-compose.docs.yml‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,9 @@
1-
version: '3'
2-
31
services:
42
docs:
53
container_name: stac-fastapi-docs-dev
64
build:
75
context: .
86
dockerfile: Dockerfile.docs
97
platform: linux/amd64
10-
environment:
11-
- POSTGRES_USER=username
12-
- POSTGRES_PASS=password
13-
- POSTGRES_DBNAME=postgis
14-
- POSTGRES_HOST_READER=database
15-
- POSTGRES_HOST_WRITER=database
16-
- POSTGRES_PORT=5432
178
volumes:
189
- .:/opt/src

‎docs/mkdocs.yml‎

Lines changed: 47 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,39 @@ nav:
3030
- models: api/stac_fastapi/api/models.md
3131
- openapi: api/stac_fastapi/api/openapi.md
3232
- routes: api/stac_fastapi/api/routes.md
33-
- version: api/stac_fastapi/api/version.md
3433
- stac_fastapi.extensions:
3534
- module: api/stac_fastapi/extensions/index.md
3635
- core:
3736
- module: api/stac_fastapi/extensions/core/index.md
38-
- context: api/stac_fastapi/extensions/core/context.md
39-
- free_text:
40-
- module: api/stac_fastapi/extensions/core/free_text/index.md
41-
- free_text: api/stac_fastapi/extensions/core/free_text/free_text.md
42-
- request: api/stac_fastapi/extensions/core/free_text/request.md
43-
- filter:
44-
- module: api/stac_fastapi/extensions/core/filter/index.md
45-
- filter: api/stac_fastapi/extensions/core/filter/filter.md
46-
- request: api/stac_fastapi/extensions/core/filter/request.md
37+
- aggregation:
38+
- module: api/stac_fastapi/extensions/core/aggregation/index.md
39+
- aggregation: api/stac_fastapi/extensions/core/aggregation/aggregation.md
40+
- client: api/stac_fastapi/extensions/core/aggregation/client.md
41+
- request: api/stac_fastapi/extensions/core/aggregation/request.md
42+
- types: api/stac_fastapi/extensions/core/aggregation/types.md
43+
- collection_search:
44+
- module: api/stac_fastapi/extensions/core/collection_search/index.md
45+
- collection_search: api/stac_fastapi/extensions/core/collection_search/collection_search.md
46+
- client: api/stac_fastapi/extensions/core/collection_search/client.md
47+
- request: api/stac_fastapi/extensions/core/collection_search/request.md
4748
- fields:
4849
- module: api/stac_fastapi/extensions/core/fields/index.md
4950
- fields: api/stac_fastapi/extensions/core/fields/fields.md
5051
- request: api/stac_fastapi/extensions/core/fields/request.md
52+
- filter:
53+
- module: api/stac_fastapi/extensions/core/filter/index.md
54+
- filter: api/stac_fastapi/extensions/core/filter/filter.md
55+
- request: api/stac_fastapi/extensions/core/filter/request.md
56+
- free_text:
57+
- module: api/stac_fastapi/extensions/core/free_text/index.md
58+
- free_text: api/stac_fastapi/extensions/core/free_text/free_text.md
59+
- request: api/stac_fastapi/extensions/core/free_text/request.md
60+
- pagination:
61+
- module: api/stac_fastapi/extensions/core/pagination/index.md
62+
- pagination: api/stac_fastapi/extensions/core/pagination/pagination.md
63+
- offset_pagination: api/stac_fastapi/extensions/core/pagination/offset_pagination.md
64+
- token_pagination: api/stac_fastapi/extensions/core/pagination/token_pagination.md
65+
- request: api/stac_fastapi/extensions/core/pagination/request.md
5166
- query:
5267
- module: api/stac_fastapi/extensions/core/query/index.md
5368
- query: api/stac_fastapi/extensions/core/query/query.md
@@ -57,14 +72,9 @@ nav:
5772
- request: api/stac_fastapi/extensions/core/sort/request.md
5873
- sort: api/stac_fastapi/extensions/core/sort/sort.md
5974
- transaction: api/stac_fastapi/extensions/core/transaction.md
60-
- pagination:
61-
- module: api/stac_fastapi/extensions/core/pagination/index.md
62-
- pagination: api/stac_fastapi/extensions/core/pagination/pagination.md
63-
- token_pagination: api/stac_fastapi/extensions/core/pagination/token_pagination.md
64-
- version: api/stac_fastapi/extensions/version.md
6575
- third_party:
76+
- module: api/stac_fastapi/extensions/third_party/index.md
6677
- bulk_transactions: api/stac_fastapi/extensions/third_party/bulk_transactions.md
67-
- index: api/stac_fastapi/extensions/third_party/index.md
6878
- stac_fastapi.types:
6979
- module: api/stac_fastapi/types/index.md
7080
- config: api/stac_fastapi/types/config.md
@@ -77,7 +87,6 @@ nav:
7787
- rfc3339: api/stac_fastapi/types/rfc3339.md
7888
- search: api/stac_fastapi/types/search.md
7989
- stac: api/stac_fastapi/types/stac.md
80-
- version: api/stac_fastapi/types/version.md
8190
- Migration Guides:
8291
- v2.5 -> v3.0: migrations/v3.0.0.md
8392
- v3.0 -> v4.0: migrations/v4.0.0.md
@@ -89,6 +98,27 @@ plugins:
8998
- search
9099
- mkdocstrings:
91100
enable_inventory: true
101+
handlers:
102+
python:
103+
paths: [src]
104+
options:
105+
docstring_section_style: list
106+
docstring_style: google
107+
line_length: 100
108+
separate_signature: true
109+
show_root_heading: true
110+
show_signature_annotations: true
111+
show_source: false
112+
show_symbol_type_toc: true
113+
signature_crossrefs: true
114+
extensions:
115+
- griffe_inherited_docstrings
116+
inventories:
117+
- https://docs.python.org/3/objects.inv
118+
- https://docs.pydantic.dev/latest/objects.inv
119+
- https://fastapi.tiangolo.com/objects.inv
120+
- https://www.starlette.io/objects.inv
121+
- https://www.attrs.org/en/stable/objects.inv
92122

93123
# Theme
94124
theme:

‎docs/src/api/stac_fastapi/api/app.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: stac_fastapi.api.app
2+
options:
3+
show_source: true

‎docs/src/api/stac_fastapi/api/config.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: stac_fastapi.api.config
2+
options:
3+
show_source: true

‎docs/src/api/stac_fastapi/api/errors.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: stac_fastapi.api.errors
2+
options:
3+
show_source: true

‎docs/src/api/stac_fastapi/api/index.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Module stac_fastapi.api
2+
3+
Api submodule.
4+
5+
## Sub-modules
6+
7+
* [stac_fastapi.api.app](app.md)
8+
* [stac_fastapi.api.config](config.md)
9+
* [stac_fastapi.api.errors](errors.md)
10+
* [stac_fastapi.api.middleware](middleware.md)
11+
* [stac_fastapi.api.models](models.md)
12+
* [stac_fastapi.api.openapi](openapi.md)
13+
* [stac_fastapi.api.routes](routes.md)
14+

‎docs/src/api/stac_fastapi/api/middleware.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
::: stac_fastapi.api.middleware
2+
options:
3+
show_source: true

0 commit comments

Comments
 (0)