108 lines
3.1 KiB
YAML
108 lines
3.1 KiB
YAML
|
site_name: stac-fastapi-pgstac
|
||
|
|
site_description: STAC FastAPI - pgstac backend.
|
||
|
|
|
||
|
|
# Repository
|
||
|
|
repo_name: "stac-utils/stac-fastapi-pgstac"
|
||
|
|
repo_url: "https://github.com/stac-utils/stac-fastapi-pgstac"
|
||
|
|
edit_uri: "blob/master/docs/src/"
|
||
|
|
|
||
|
|
# Social links
|
||
|
|
extra:
|
||
|
|
social:
|
||
|
|
- icon: "fontawesome/brands/github"
|
||
|
|
link: "https://github.com/stac-utils"
|
||
|
|
|
||
|
|
# Layout
|
||
|
|
nav:
|
||
|
|
- Home: "index.md"
|
||
|
|
- Configuration: "settings.md"
|
||
|
|
- API:
|
||
|
|
- stac_fastapi.pgstac:
|
||
|
|
- module: api/stac_fastapi/pgstac/index.md
|
||
|
|
- app: api/stac_fastapi/pgstac/app.md
|
||
|
|
- config: api/stac_fastapi/pgstac/config.md
|
||
|
|
- core: api/stac_fastapi/pgstac/core.md
|
||
|
|
- db: api/stac_fastapi/pgstac/db.md
|
||
|
|
- extensions:
|
||
|
|
- module: api/stac_fastapi/pgstac/extensions/index.md
|
||
|
|
- filter: api/stac_fastapi/pgstac/extensions/filter.md
|
||
|
|
- query: api/stac_fastapi/pgstac/extensions/query.md
|
||
|
|
- models:
|
||
|
|
- module: api/stac_fastapi/pgstac/models/index.md
|
||
|
|
- links: api/stac_fastapi/pgstac/models/links.md
|
||
|
|
- transactions: api/stac_fastapi/pgstac/transactions.md
|
||
|
|
- utils: api/stac_fastapi/pgstac/utils.md
|
||
|
|
- Development - Contributing: "contributing.md"
|
||
|
|
- Release Notes: "release-notes.md"
|
||
|
|
|
||
|
|
plugins:
|
||
|
|
- search
|
||
|
|
- mkdocstrings:
|
||
|
|
enable_inventory: true
|
||
|
|
handlers:
|
||
|
|
python:
|
||
|
|
options:
|
||
|
|
docstring_section_style: list
|
||
|
|
docstring_style: google
|
||
|
|
line_length: 100
|
||
|
|
separate_signature: true
|
||
|
|
show_root_heading: true
|
||
|
|
show_signature_annotations: true
|
||
|
|
show_source: false
|
||
|
|
show_symbol_type_toc: true
|
||
|
|
signature_crossrefs: true
|
||
|
|
extensions:
|
||
|
|
- griffe_inherited_docstrings
|
||
|
|
inventories:
|
||
|
|
- https://docs.python.org/3/objects.inv
|
||
|
|
- https://docs.pydantic.dev/latest/objects.inv
|
||
|
|
- https://fastapi.tiangolo.com/objects.inv
|
||
|
|
- https://www.starlette.io/objects.inv
|
||
|
|
- https://magicstack.github.io/asyncpg/current/objects.inv
|
||
|
|
- https://stac-utils.github.io/stac-fastapi/objects.inv
|
||
|
|
- https://www.attrs.org/en/stable/objects.inv
|
||
|
|
|
||
|
|
# Theme
|
||
|
|
theme:
|
||
|
|
icon:
|
||
|
|
logo: "material/home"
|
||
|
|
repo: "fontawesome/brands/github"
|
||
|
|
name: "material"
|
||
|
|
language: "en"
|
||
|
|
font:
|
||
|
|
text: "Nunito Sans"
|
||
|
|
code: "Fira Code"
|
||
|
|
|
||
|
|
extra_css:
|
||
|
|
- stylesheets/extra.css
|
||
|
|
|
||
|
|
# These extensions are chosen to be a superset of Pandoc's Markdown.
|
||
|
|
# This way, I can write in Pandoc's Markdown and have it be supported here.
|
||
|
|
# https://pandoc.org/MANUAL.html
|
||
|
|
markdown_extensions:
|
||
|
|
- admonition
|
||
|
|
- attr_list
|
||
|
|
- codehilite:
|
||
|
|
guess_lang: false
|
||
|
|
- def_list
|
||
|
|
- footnotes
|
||
|
|
- pymdownx.arithmatex
|
||
|
|
- pymdownx.betterem
|
||
|
|
- pymdownx.caret:
|
||
|
|
insert: false
|
||
|
|
- pymdownx.details
|
||
|
|
- pymdownx.emoji
|
||
|
|
- pymdownx.escapeall:
|
||
|
|
hardbreak: true
|
||
|
|
nbsp: true
|
||
|
|
- pymdownx.magiclink:
|
||
|
|
hide_protocol: true
|
||
|
|
repo_url_shortener: true
|
||
|
|
- pymdownx.smartsymbols
|
||
|
|
- pymdownx.superfences
|
||
|
|
- pymdownx.tasklist:
|
||
|
|
custom_checkbox: true
|
||
|
|
- pymdownx.tilde
|
||
|
|
- toc:
|
||
|
|
permalink: true
|