Skip to content

Commit

Permalink
docs: separating metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
marius committed Nov 26, 2024
1 parent 80c25d7 commit 9b302a9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,9 @@ from qseek.models.station import Stations

print(generate_docs(Stations()))
```

::: qseek.models.station.Stations
options:
heading_level: 4
extensions:
- griffe_pydantic
24 changes: 22 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,29 @@ watch:

plugins:
- search
- markdown-exec
- mkdocstrings:
default_handler: python
- markdown-exec
handlers:
python:
paths: [src]
import:
- https://docs.python.org/3/objects.inv
- https://docs.pydantic.dev/latest/objects.inv
options:
extensions:
- griffe_pydantic:
schema: false
inherited_members: true
show_signature_annotations: true
show_symbol_type_toc: true
separate_signature: true
show_root_heading: true
show_source: false
show_symbol_type_heading: true
signature_crossrefs: true
summary: true


nav:
- The Earthquake Detector:
Expand All @@ -79,7 +99,7 @@ nav:
- Benchmark: benchmark.md
- Configuration:
- The Search: components/configuration.md
- Station Metadata: components/stations.md
- Station Metadata: components/station_metadata.md
- Waveform Data: components/waveform_data.md
- Octree: components/octree.md
- Ray Tracer: components/ray_tracer.md
Expand Down
3 changes: 0 additions & 3 deletions src/qseek/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,9 +188,6 @@ def _check(self) -> NSL:
NSL = Annotated[_NSL, BeforeValidator(_NSL.parse), AfterValidator(_NSL._check)]


NSL = Annotated[_NSL, BeforeValidator(_NSL.parse), AfterValidator(_NSL._check)]


class _Range(NamedTuple):
min: float
max: float
Expand Down

0 comments on commit 9b302a9

Please sign in to comment.