forked from tianocore/edk2-pytool-extensions
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
90 lines (84 loc) · 2.36 KB
/
mkdocs.yml
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: Tianocore Edk2 Pytool Extensions (edk2toolext)
repo_url: https://github.com/tianocore/edk2-pytool-extensions
copyright: Copyright (c) Microsoft. All rights reserved
site_description: edk2toolext package documentation
theme:
name: readthedocs
docs_dir: docs/user
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
- exclude:
glob:
- coverage.md
- publishing.md
- developing.md
- gen-files:
scripts:
- docs/user/gen_api.py
- awesome-pages
extra_javascript:
- https://unpkg.com/[email protected]/dist/mermaid.min.js
markdown_extensions:
- markdown_include.include:
base_path: .
- admonition
- codehilite
- meta
- fenced_code
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- pymdownx.tabbed
- toc:
permalink: true
watch:
- 'docs/user'
- 'mkdocs.yml'
- 'edk2toolext/'
nav:
- Our Philosophy: index.md
- Using Stuart:
- Installation Instructions: using/install.md
- Build Instructions: using/build.md
- Core CI Instructions: using/ci.md
- Integrating Stuart:
- Build with Stuart: integrate/build.md
- Core CI with Stuart: integrate/manage.md
- Porting Example: integrate/porting.md
- ... | tools/**/*.md
- Advanced Features:
- Invocables: features/invocable.md
- Creating Invocables: features/creating_invocable.md
- Ext Deps: features/extdep.md
- Creating Ext Deps: features/creating_extdep.md
- Plugins: features/plugin_manager.md
- Create a Plugin: features/creating_plugins.md
- Environment Variables: features/environment_variables.md
- Self Describing Environment: features/sde.md
- Settings Manager: features/settings_manager.md
- Logging: features/logging.md
- WSL: features/using_linux.md
- API Reference:
- ... | flat | api/**/*.md