PyRecEst/mkdocs.yml at main · FlorianPfaff/PyRecEst · 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
site_name: PyRecEst
site_description: Recursive Bayesian Estimation for Python.
repo_url: https://github.com/FlorianPfaff/PyRecEst
repo_name: FlorianPfaff/PyRecEst

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Examples: examples.md
  - Guides:
      - Choosing an API: choosing-an-api.md
      - Distribution Taxonomy: distribution-taxonomy.md
      - CLI: cli.md
      - Installation Footprint: install-footprint.md
      - Scenario Zoo: scenario-zoo.md
      - Compatibility Dashboard: compatibility-dashboard.md
      - Flagship Example: flagship-example.md
      - Change Management: change-management.md
      - Diagnostics: diagnostics.md
      - Numerical Contracts: numerical-contracts.md
      - Shapes and Conventions: conventions.md
      - Quality Gates: quality-gates.md
      - Backend Compatibility: backend-compatibility.md
      - Backend Support Matrix: backend-support.md
      - Backend API Matrix: backend-api-matrix.md
      - Performance: performance.md
      - Release Process: release-process.md
      - Failure Modes: failure-modes.md
      - Error Handling: error-handling.md
      - API Stability: stability-policy.md
      - Public API Registry: public-api-registry.md
      - Ecosystem Positioning: ecosystem.md
      - Public Identity: public-identity.md
      - Reproducible Experiments: reproducible-experiments.md
      - Scientific Validation: scientific-validation.md
      - Representation Conversion: representation-conversion.md
      - Model Objects: models.md
      - Public Protocols: protocols.md
      - Protocol Capability Matrix: protocol-capability-matrix.md
      - Custom Distribution Extensions: custom-distribution.md
      - Custom Filter Extensions: custom-filter.md
  - Tutorials:
      - Overview: tutorials/index.md
      - Use a Distribution: tutorials/use-a-distribution.md
      - Write a Filter Loop: tutorials/write-a-filter-loop.md
      - Backend-Portable Workflows: tutorials/backend-portable-workflows.md
      - Robust Kalman Updates: tutorials/robust-kalman-update.md
      - Run a Tracker: tutorials/run-a-tracker.md
      - Evaluate a Simulation: tutorials/evaluate-a-simulation.md
  - API Overview: api-overview.md
  - API Reference:
      - Reference Index: reference/index.md
      - Distributions: reference/distributions.md
      - Filters: reference/filters.md
      - Models: reference/models.md
      - Smoothers: reference/smoothers.md
      - Sampling: reference/sampling.md
      - Evaluation: reference/evaluation.md
      - Utilities: reference/utils.md

theme:
  name: mkdocs

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            docstring_style: sphinx
            show_if_no_docstring: true
            show_source: false
            members_order: source

strict: true