compression-safeguards/properdocs.yml at main · juntyr/compression-safeguards · 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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
site_name: compression-safeguards
site_author: Juniper Tyree
site_url: !ENV READTHEDOCS_CANONICAL_URL
repo_url: https://github.com/juntyr/compression-safeguards/
edit_uri: blob/main/

strict: true

markdown_extensions:
  - footnotes
  - pymdownx.superfences
  - pymdownx.highlight:
      use_pygments: true
      noclasses: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details

extra_javascript:
  - js/katex.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
  - https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js

extra_css:
  - css/logo.css
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css

theme:
  name: readthedocs
  custom_dir: docs/overrides
  highlightjs: false
  navigation_depth: 99

nav:
  - Home: index.md
  - Try the safeguards: try-repl.md
  - API Reference:
      - Overview: api.md
  - Examples:
      - Datasets: https://github.com/juntyr/compression-safeguards/tree/main/examples/data
      - Special values:
          - NaN values: examples/nan.ipynb
          - Missing values: examples/missing.ipynb
      - Regions of Interest (RoIs):
          - Latent Heat Flux: examples/latent-heat-flux.ipynb
      - Quantities of Interest (QoIs):
          - "Pointwise: Log-scale Specific Humidity": examples/log-scale.ipynb
          - "Semi-Pointwise: Kinetic energy": examples/kinetic-energy.ipynb
          - Higher-order derivatives: examples/derivative.ipynb
          - "Neighbourhood: Relative Vorticity": examples/vorticity.ipynb
          - Bounding the dSSIM metric: examples/dssim.ipynb
      - Topology:
          - Precipitation extrema: examples/precipitation.ipynb
          - Isosurfaces: examples/isosurface.ipynb
      - Error bound distributions:
          - Absolute error bound: examples/error-distribution.ipynb
      - Safeguards on chunked data:
          - xarray-safeguards: examples/chunked.ipynb
      - Preview:
          - Incremental safeguards: examples/incremental.ipynb
  - Links:
      - GitHub: https://github.com/juntyr/compression-safeguards
      - PyPI:
          - compression-safeguards: https://pypi.org/project/compression-safeguards/
          - numcodecs-safeguards: https://pypi.org/project/numcodecs-safeguards/
          - xarray-safeguards: https://pypi.org/project/xarray-safeguards/
      - Manuscript: https://doi.org/10.5194/egusphere-2026-4266

not_in_nav: |
  try-notebook.md

plugins:
  - exclude:
      glob:
        - examples/*.py
        - examples/data/*/*.md
        - hooks/*
        - overrides/*
  - search
  - open-in-new-tab
  - autorefs
  - macros:
      module_name: docs/hooks/macros
      on_error_fail: true
      on_undefined: strict
      render_by_default: false
  - mkdocstrings-python-generator:
      source_dirs:
        - nav_heading: [API Reference]
          base: src
          edit_uri: blob/main/src/
          ignore: ["_compat.py", "_float128.py", "_qois"]
        - nav_heading: [API Reference]
          base: packages/numcodecs-safeguards/src
          edit_uri: blob/main/packages/numcodecs-safeguards/src/
        - nav_heading: [API Reference]
          base: packages/xarray-safeguards/src
          edit_uri: blob/main/packages/xarray-safeguards/src/
  - mkdocs-jupyter:
      ignore_h1_titles: True
      no_prompt: True
      include_source: True
  - mkdocs-simple-hooks:
      hooks:
        on_nav: "docs.hooks.section_index:on_nav"
        on_page_context: "docs.hooks.edit_uri:on_page_context"
        on_page_markdown: "docs.hooks.api_index:on_page_markdown"
  - section-index
  - mkdocstrings:
      enable_inventory: true
      handlers:
        python:
          options:
            docstring_section_style: list
            docstring_style: numpy
            show_if_no_docstring: true
            filters: ["!^_$", "!^_[^_]", "!^__", "^__init__$", "^__call__$"]
            members_order: source
            group_by_category: false
            show_source: false
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            relative_crossrefs: true
            show_root_toc_entry: true
            merge_init_into_class: true
            summary:
              attributes: false
              classes: true
              functions: true
              modules: true
            backlinks: tree
            show_inheritance_diagram: true
            inheritance_diagram_direction: LR
            extensions: ["dataclasses"]
            preload_modules:
              - abc
              - enum
              - numcodecs
              - numcodecs_combinators
          inventories:
            - https://docs.python.org/3.11/objects.inv
            - https://numcodecs.readthedocs.io/en/v0.16.5/objects.inv
            - https://numcodecs-combinators.readthedocs.io/en/v0.2.15/objects.inv
            - https://numcodecs-replace.readthedocs.io/en/0.1.2/objects.inv
            - https://numcodecs-zero.readthedocs.io/en/0.1.2/objects.inv
            - https://numpy.org/doc/2.4/objects.inv
            - https://python-semver.readthedocs.io/en/3.0.0/objects.inv
            - https://docs.xarray.dev/en/v2025.04.0/objects.inv
            - https://typing-extensions.readthedocs.io/en/stable/objects.inv

watch:
  - docs
  - examples
  - packages
  - src