PyChebyshev/mkdocs.yml at main · 0xC000005/PyChebyshev · 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
site_name: PyChebyshev
site_description: Fast multi-dimensional Chebyshev tensor interpolation with analytical derivatives
repo_url: https://github.com/0xC000005/PyChebyshev
repo_name: PyChebyshev

theme:
  name: material
  features:
    - content.code.copy
    - navigation.sections
    - navigation.top
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      accent: indigo

exclude_docs: |
  superpowers/

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

extra_javascript:
  - javascripts/katex.js
  - https://unpkg.com/katex@0/dist/katex.min.js
  - https://unpkg.com/katex@0/dist/contrib/auto-render.min.js

extra_css:
  - https://unpkg.com/katex@0/dist/katex.min.css

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            docstring_style: numpy
            members_order: source

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - User Guide:
      - Mathematical Concepts: user-guide/concepts.md
      - Usage Patterns: user-guide/usage.md
      - Saving & Loading: user-guide/serialization.md
      - Binary Format: user-guide/binary-format.md
      - Computing Greeks: user-guide/greeks.md
      - Sliding Technique: user-guide/sliding.md
      - Chebyshev Splines: user-guide/spline.md
      - Tensor Train: user-guide/tensor-train.md
      - Tensor Train ALS: user-guide/tensor-train-als.md
      - Chebyshev Algebra: user-guide/algebra.md
      - Extrusion & Slicing: user-guide/extrude-slice.md
      - Chebyshev Calculus: user-guide/calculus.md
      - Pre-computed Values: user-guide/from-values.md
      - Error Estimation: user-guide/error-estimation.md
      - Error-Driven Construction: user-guide/error-driven-construction.md
      - Special Points: user-guide/special-points.md
      - Ergonomics: user-guide/ergonomics.md
      - Build & Diagnostics: user-guide/build-diagnostics.md
      - Adaptive Refinement: user-guide/adaptive-refinement.md
      - Cross-language readers: user-guide/cross-language-readers.md
  - API Reference: api/reference.md
  - Benchmarks: benchmarks.md
  - Roadmap: roadmap.md