equation-tree/mkdocs.yml at main · AutoResearch/equation-tree · 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
site_name: Equation Tree
repo_url: 'https://github.com/AutoResearch/equation-tree'

site_url: 'https://autoresearch.github.io/equation-tree/'
edit_uri: 'blob/main/docs/'

extra:
  colab_base_url: 'https://colab.research.google.com/github/AutoResearch/equation-tree/blob/gh-pages/'
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/AutoResearch

nav:
  - Introduction: 'index.md'
  - Quickstart: 'quickstart.md'
  - User Guide:
      - Equation Formats: 'user-guide/equation-formats.md'
      - Equation Sampling: 'user-guide/equation-sampling.md'
      - Distance Metrics: 'user-guide/distance-metrics.md'
      - Additional Features: 'user-guide/additional-features.md'
  - Tutorials:
      - Basic Usage: 'tutorials/Basic Usage.ipynb'
      - Distance Metrics: 'tutorials/Distance Metrics.ipynb'
      - Analysing Equation Distributions: 'tutorials/Analysing Equation Distribution.ipynb'
  - Code Reference: reference/

theme:
  name: material
  features:

  language: en
  logo: img/logo.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  custom_dir: mkdocs/overrides


watch:
  - src/

plugins:
  - search
  - gen-files:
      scripts:
        - mkdocs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY/index.html
  - section-index
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://scikit-learn.org/stable/objects.inv
  - mkdocs-jupyter: # required to convert Jupyter notebooks
      include_source: true
      execute: false
      ignore_h1_titles: true
hooks:
  - mkdocs/hooks.py

markdown_extensions:
  admonition: { }
  pymdownx.details: { }
  pymdownx.superfences: { }
  pymdownx.arithmatex: # required for equation display
    generic: true
  pymdownx.snippets: { }
  pymdownx.tabbed:
    alternate_style: true

extra_javascript: [
  # requirements for pymdownx.arithmetex:
  "javascripts/mathjax.js",
  "https://polyfill.io/v3/polyfill.min.js?features=es6",
  "https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"
]