carbon/mkdocs.yml at main · ImperialCollegeLondon/carbon · 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
site_name: carbon
watch: [carbon]

theme:
  name: material

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - mdx_math:
      enable_dollar_delimiter: true
  - pymdownx.snippets:
      check_paths: true
  - toc:
      permalink: ¤

plugins:
  - search
  - include-markdown # https://github.com/mondeja/mkdocs-include-markdown-plugin
  - gen-files:
      scripts:
        - docs/gen_ref_nav.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            merge_init_into_class: true

nav:
  - carbon documentation: index.md
  - Methodology: methodology.md
  - Sources: sources.md
  # defer to gen-files + literate-nav
  - Code Reference: reference/

# Render math in mkdocs
extra_javascript:
  - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML