quax/mkdocs.yml at main · nstarman/quax · 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
theme:
    name: material
    features:
        - navigation.sections  # Sections are included in the navigation on the left.
        - toc.integrate  # Table of contents is integrated on the left; does not appear separately on the right.
        - header.autohide  # header disappears as you scroll
    palette:
        # Light mode / dark mode
        # We deliberately don't automatically use `media` to check a user's preferences. We default to light mode as
        # (a) it looks more professional, and (b) is more obvious about the fact that it offers a (dark mode) toggle.
        - scheme: default
          primary: white
          accent: amber
          toggle:
             icon: material/weather-night
             name: Switch to dark mode
        - scheme: slate
          primary: black
          accent: amber
          toggle:
             icon: material/weather-sunny
             name: Switch to light mode
    icon:
        repo: fontawesome/brands/github  # GitHub logo in top right
        logo: "material/duck"  # Quax logo in top left
    favicon: "_static/favicon.svg"
    custom_dir: "docs/_overrides"  # Overriding part of the HTML

site_name: Quax
site_description: The documentation for the Quax software library.
site_author: Nathaniel Starkman
site_url: https://nstarman.github.io/quax

repo_url: https://github.com/nstarman/quax
repo_name: nstarman/quax
edit_uri: ""  # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate

extra_javascript:
    # The below two make MathJax work, see https://squidfunk.github.io/mkdocs-material/reference/mathjax/
    - _static/mathjax.js
    - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
    - _static/custom_css.css

markdown_extensions:
    - pymdownx.arithmatex:  # Render LaTeX via MathJax
        generic: true
    - pymdownx.superfences  # Seems to enable syntax highlighting when used with the Material theme.
    - pymdownx.tabbed:
        alternate_style: true
    - pymdownx.details  # Allowing hidden expandable regions denoted by ???
    - pymdownx.snippets:  # Include one Markdown file into another
        base_path: docs
    - admonition
    - toc:
        permalink: "¤"  # Adds a clickable permalink to each section heading
        toc_depth: 4

plugins:
    - search:
        # See https://github.com/squidfunk/mkdocs-material/discussions/8116#discussioncomment-12632752
        # and https://github.com/patrick-kidger/equinox/issues/984
        # In particular this allows for searching e.g. 'filter_grad' and to match 'equinox.filter_grad'.
        separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
    - hippogriffe:
        extra_public_objects:
            - jax.core.AbstractValue
            - jax.extend.core.Primitive
    - mkdocstrings:
        handlers:
            python:
                options:
                    force_inspection: true
                    heading_level: 4
                    inherited_members: true
                    members_order: source
                    show_bases: false
                    show_if_no_docstring: true
                    show_overloads: false
                    show_root_heading: true
                    show_signature_annotations: true
                    show_source: false
                    show_symbol_type_heading: true
                    show_symbol_type_toc: true

nav:
    - 'index.md'
    - Tutorials:
        - 'tutorials/use-a-quax-type.md'
        - 'Custom rules (introductory)': 'examples/custom_rules.md'
        - 'Default rules (intermediate)': 'examples/default_rules.md'
        - 'Redispatching (advanced)': 'examples/redispatch.md'
    - How-to:
        - 'how-to/combine-with-jit-and-vmap.md'
        - 'how-to/resolve-an-ambiguous-rule.md'
        - 'how-to/quaxify-part-of-a-function.md'
        - 'how-to/recover-a-nan-gradient.md'
        - 'how-to/transform-metadata-under-autodiff.md'
    - Explanation:
        - 'how-quaxify-works.md'
        - 'autodiff.md'
        - 'control-flow.md'
        - 'hijax.md'
        - 'why-not-built-on-hijax.md'
        - 'sharp-bits.md'
    - Reference:
        - 'api/quax.md'
        - 'api/lora.md'
        - 'api/unitful.md'
        - 'api/hijax.md'
        - 'api/experimental.md'
        - 'examples/other.md'
    - 'faq.md'