thrml/mkdocs.yml at main · extropic-ai/thrml · 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
# adapted from https://github.com/patrick-kidger/equinox/blob/main/mkdocs.yml
theme:
    name: material
    features:
        - navigation.sections
        - toc.integrate
        - header.autohide
        - content.code.copy
    palette:
        - scheme: slate
          primary: black
          accent: amber
    icon:
        repo: fontawesome/brands/github
    logo: "_static/logo/logo.svg"
    favicon: "_static/favicon.png"
    custom_dir: "docs/_overrides"

site_name: THRML
site_description: The documentation for the THRML software library.
site_author: Extropic AI
site_url: https://extropic-ai.github.io/thrml

repo_url: https://github.com/extropic-ai/thrml
repo_name: extropic-ai/thrml
edit_uri: ""

strict: false

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
    - _static/video_handler.js

extra_css:
    - _static/custom_css.css

markdown_extensions:
    - pymdownx.arithmatex:
        generic: true
    - pymdownx.superfences
    - pymdownx.details
    - pymdownx.snippets:
        base_path: docs
    - admonition
    - toc:
        permalink: "¤"
        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
        separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
    - include_exclude_files:
        include:
            - ".htaccess"
        exclude:
            - "_overrides"
            - "examples/.ipynb_checkpoints/"
            - "examples/MNIST"
            - "examples/bert_checkpoint.eqx"
    - ipynb
    - hippogriffe:
        extra_public_objects:
            - equinox.if_array
            - jax.ShapeDtypeStruct
            - jax.extend.core.ClosedJaxpr
            - jax.Device
            - jax.sharding.Sharding
    - 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'
    - 'examples/00_probabilistic_computing.ipynb'
    - Examples:
        - 'examples/01_all_of_thrml.ipynb'
        - 'examples/02_spin_models.ipynb'
    - API Reference:
        - 'api/pgm.md'
        - 'api/block_management.md'
        - 'api/interaction.md'
        - 'api/factor.md'
        - 'api/conditional_samplers.md'
        - 'api/block_sampling.md'
        - 'api/observers.md'
        - Models:
            - 'api/models/ebm.md'
            - 'api/models/discrete_ebm.md'
            - 'api/models/ising.md'
    - Further details:
      - 'architecture.md'