honua-sdk-python/mkdocs.yml at trunk · honua-io/honua-sdk-python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
site_name: Honua Python SDK
site_description: Honua data-plane and control-plane Python clients
repo_url: https://github.com/honua-io/honua-sdk-python
docs_dir: docs

exclude_docs: |
  README.md

validation:
  omitted_files: info
  links:
    # `warn` so intra-doc typos (broken relative links inside docs/) surface
    # as warnings under `mkdocs build --strict`. Cross-repo relative links
    # pointing outside the docs_dir (e.g. ../examples/..., ../INSTALL.md,
    # ../compatibility/...) are documented as resolving on the GitHub render
    # and are deliberately allowed: mkdocs warns about them but they are
    # routed through the `unrecognized_links: info` channel below for
    # paths it cannot resolve at all.
    not_found: warn
    absolute_links: warn
    unrecognized_links: info

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: teal
      accent: teal

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Guides:
      - Core client: core-client.md
      - Protocol examples: protocol-examples.md
      - Protocol parity: protocol-parity.md
      - Authentication: auth.md
      - Geoprocessing job lifecycle: geoprocessing-job-lifecycle.md
      - Compatibility: compatibility.md
      - SDK capability coverage: sdk-coverage.md
      - Troubleshooting: troubleshooting.md
      - Diagnostic bundles: diagnostic-bundles.md
  - Examples: examples.md
  - Deep dives:
      - Retries and timeouts: retries-and-timeouts.md
      - Pagination: pagination.md
  - API Reference:
      - honua-sdk:
          - Clients: reference/honua-sdk/clients.md
          - Source facade: reference/honua-sdk/source-facade.md
          - Models: reference/honua-sdk/models.md
          - Errors: reference/honua-sdk/errors.md
      - honua-admin:
          - Clients: reference/honua-admin/clients.md
          - Models: reference/honua-admin/models.md
          - Errors: reference/honua-admin/errors.md
  - Project:
      - Operating cadence: operating-cadence.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - packages/honua-sdk
            - packages/honua-admin
          options:
            show_root_heading: true
            show_source: false
            members_order: source
            docstring_style: google

markdown_extensions:
  - admonition
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra:
  # `mike` reads this block to render the version selector in the
  # Material theme. The deploy job in .github/workflows/docs.yml runs
  # `mike deploy --push --update-aliases latest` on every `trunk` push,
  # so the `latest` alias always points at the most recent build.
  version:
    provider: mike
    default: latest