jpc/mkdocs.yml at main · thebuckleylab/jpc · 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
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_light_mode: "_static/logo-light.svg"  # jpc logo in top left
    logo_dark_mode: "_static/logo-dark.svg"  # jpc logo in top left
    favicon: "_static/favicon.png"
    custom_dir: "docs/_overrides"  # Overriding part of the HTML

site_name: jpc
site_description: The documentation for the jpc software library.
site_author: Francesco Innocenti
site_url: https://thebuckleylab.github.io/jpc/

repo_url: https://github.com/thebuckleylab/jpc
repo_name: thebuckleylab/jpc
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

strict: true  # Don't allow warnings during the build process

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.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:
        separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
    - include_exclude_files:
        include:
            - ".htaccess"
        exclude:
            - "_overrides"
            - "examples/.ipynb_checkpoints/"
            - "examples/analytical_inference_with_linear_net.ipynb"
    - ipynb
    - 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'
    - ⚙️ How it works:
        - Basic usage: 'basic_usage.md'
        - Advanced usage: 'advanced_usage.md'
    - 📚 Examples:
        - Introductory:
            - Discriminative PC: 'examples/discriminative_pc.ipynb'
            - Supervised generative PC: 'examples/supervised_generative_pc.ipynb'
            - Unsupervised generative PC: 'examples/unsupervised_generative_pc.ipynb'
        - Advanced:
            - μPC: 'examples/mupc.ipynb'
            - ePC: 'examples/epc.ipynb'
            - Hybrid PC: 'examples/hybrid_pc.ipynb'
            - Bidirectional PC: 'examples/bidirectional_pc.ipynb'
            - Linear theoretical energy: 'examples/linear_net_theoretical_energy.ipynb'
            - JPC from scratch: 'examples/jpc_from_scratch.ipynb'
    - 🌱 Basic API:
          - 'api/Training.md'
          - 'api/Testing.md'
          - 'api/Utils.md'
    - 🚀 Advanced API:
        - 'api/Initialisation.md'
        - 'api/Energy functions.md'
        - 'api/Gradients.md'
        - 'api/Continuous-time Inference.md'
        - 'api/Discrete updates.md'
        - 'api/Theoretical tools.md'

copyright: |
  &copy; 2024 <a href="https://github.com/thebuckleylab"  target="_blank" rel="noopener">thebuckleylab</a>