dimtensor/mkdocs.yml at main · marcoloco23/dimtensor · 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
site_name: dimtensor
site_description: Unit-aware tensors for physics and scientific machine learning - NumPy, PyTorch, and JAX with physical units
site_url: https://marcoloco23.github.io/dimtensor
repo_url: https://github.com/marcoloco23/dimtensor
repo_name: marcoloco23/dimtensor

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/marcoloco23/dimtensor
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dimtensor/

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search:
      separator: '[\s\-\.]+'
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            heading_level: 2
            members_order: source
            docstring_style: google
            show_signature_annotations: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
    - Working with Units: guide/units.md
    - Array Operations: guide/operations.md
    - PyTorch Integration: guide/pytorch.md
    - JAX Integration: guide/jax.md
    - Physics ML: guide/physics-ml.md
    - Visualization: guide/visualization.md
    - Validation: guide/validation.md
    - Inference: guide/inference.md
    - Datasets: guide/datasets.md
    - Equations: guide/equations.md
    - Examples: guide/examples.md
  - API Reference:
    - Core:
      - DimArray: api/dimarray.md
      - Units: api/units.md
      - Functions: api/functions.md
    - Frameworks:
      - PyTorch: api/torch.md
    - ML Tools:
      - Validation: api/validation.md
      - Inference: api/inference.md
      - Visualization: api/visualization.md
    - Integration:
      - Ecosystem: api/ecosystem.md
      - Integrations: api/integrations.md
  - Comparisons:
    - Overview: comparisons/index.md
    - dimtensor vs Pint: comparisons/vs-pint.md
    - dimtensor vs Astropy: comparisons/vs-astropy.md
    - dimtensor vs unyt: comparisons/vs-unyt.md
    - Feature Matrix: comparisons/feature-matrix.md
  - Performance:
    - Benchmarks: performance/benchmarks.md
  - Troubleshooting:
    - Common Errors: troubleshooting/errors.md
    - FAQ: troubleshooting/faq.md
    - Migration Guide: troubleshooting/migration.md
  - Changelog: changelog.md