-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
136 lines (127 loc) · 3.66 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
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
site_name: Tudat Developer
site_description: Tudat Developer Documentation
site_author: Geoffrey Garrett
theme:
name: "material"
custom_dir: custom/
logo: assets/images/logo.png
palette:
- scheme: default
primary: light blue
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: light blue
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
features:
- navigation.tabs
- navigation.instant # single-page application (SPA) navigation
- content.code.annotate
- navigation.tracking
- content.code.copy
# Repository
repo_name: tudat-team/tudat-developer-docs
repo_url: https://github.com/tudat-team/tudat-developer-docs
nav:
- Home: index.md
- Overview:
- GitHub-Organized: overview/github.md
- Everything "Conda" Related: overview/conda.md
- Azure: overview/azure.md
- Documentation: overview/documentation.md
- Docstrings: overview/docstring_templates.md
- Multidoc: overview/multidoc.md
- Readthedocs: overview/readthedocs.md
- Guides:
- Update Anaconda Cloud Token: guides/update-conda-token.md
- Create a Bugfix: guides/create-bugfix.md
- Create a Feedstock: guides/create-feedstock.md
- Create a Hotfix: guides/create-hotfix.md
- Create a Release: guides/create-release.md
- Create a Feature: guides/create-feature.md
- Setup a Repository: guides/setup-repository.md
- Reference:
- Environment Variables: reference/environment-variables.md
- Managing Tokens: reference/managing-tokens.md
- Developer Workflows: reference/developer-workflows.md
- Diátaxis Framework: reference/documentation-modes.md
- Common Commands: reference/common-commands.md
- Documentation Styling: reference/documentation-styling.md
watch:
- custom
- custom/home.html
markdown_extensions:
- admonition
- attr_list
- md_in_html
- pymdownx.details
- lightgallery:
show_description_in_lightgallery: true
show_description_as_inline_caption: false
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
permalink: true
extra_css:
- /assets/css/videos.css
plugins:
- search
- inline-svg
- mkdocs-video:
# is_video: True
# video_muted: True
# video_controls: True
css_style:
width: "100%"
# height: "100%"
#plugins:
# - with-pdf:
#author: WHO
#copyright: ANY TEXT
#
#cover: false
#back_cover: true
#cover_title: TITLE TEXT
#cover_subtitle: SUBTITLE TEXT
#custom_template_path: TEMPLATES PATH
#
#toc_title: TOC TITLE TEXT
#heading_shift: false
#toc_level: 3
#ordered_chapter_level: 2
#excludes_children:
# - 'release-notes/:upgrading'
# - 'release-notes/:changelog'
#
#exclude_pages:
# - 'bugs/'
# - 'appendix/contribute/'
#convert_iframe:
# - src: IFRAME SRC
# img: POSTER IMAGE URL
# text: ALTERNATE TEXT
# - src: ...
#two_columns_level: 3
#
#render_js: true
#headless_chrome_path: headless-chromium
#
# output_path: /home/ggarrett/Repositories/tudat-developer-docs/tudat-developer/document.pdf
#enabled_if_env: ENABLE_PDF_EXPORT
#
#debug_html: true
#show_anchors: true
#verbose: true