ODYM/mkdocs.yaml at master · IndEcol/ODYM · 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
# https://www.mkdocs.org/user-guide/configuration/
site_name: ODYM Documentation
repo_url: https://github.com/IndEcol/ODYM
copyright: © International Society for Industrial Ecology and Contributors | Code under MIT License
nav:
  - Home: 'index.md'
  - Overview: 'overview.md'
  - About: 'about.md'
  - FAQ: 'faq.md'
  - Use:
    - Getting Started: 'use/gettingstarted.md'
    - Config File: 'use/configfile.md'
    - Data Templates: 'use/datatemplates.md'
    - Data Structure: 'use/datastructure.md'
    - Version Management: 'use/versionmanagement.md'
  - Tutorials:
    - tutorial: 'tutorials/tutorial_1.ipynb'
    - tutorial: 'tutorials/tutorial_2.ipynb'
    - tutorial: 'tutorials/tutorial_3.ipynb'
    - tutorial: 'tutorials/tutorial_4.ipynb'
    - tutorial: 'tutorials/tutorial_5.ipynb'
    - tutorial: 'tutorials/tutorial_6.ipynb'
  - Changelog: 'changelog.md'
theme: # https://www.mkdocs.org/user-guide/choosing-your-theme/#readthedocs
  name: material
  custom_dir: docs/_overrides
  logo: _logos/logo.svg
  favicon: _logos/logo.svg
  highlightjs: true
  navigation_depth: 4
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.top
    - content.footnote.tooltips
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search
  - include-markdown
  - mkdocs-jupyter:
      include_source: True
  - mkdocs-autoapi:
      autoapi_dir: src
      autoapi_add_nav_entry: True
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
markdown_extensions:
  - admonition
  - pymdownx.superfences
  - attr_list
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.snippets
  - pymdownx.highlight:
      use_pygments: false

extra_javascript:
  - _javascripts/katex.js
  # https://cdnjs.com/libraries/KaTeX
  # unpkg is incredibly slow (17s to load the css file)
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.js
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/contrib/auto-render.min.js
extra_css:
  # https://cdnjs.com/libraries/KaTeX
  # unpkg is incredibly slow (17s to load the css file)
  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css
  - _css/extra.css

watch:
  - src

extra:
  generator: false