-
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathmkdocs.yml
110 lines (105 loc) · 2.82 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
repo_name: dmulyalin/fakenos
repo_url: https://github.com/dmulyalin/fakenos
site_author: Denis Mulyalin
site_description: FakeNOS, Network, SSH
site_name: FakeNOS
site_url: https://fakenos.github.io/
docs_dir: docs/
theme:
logo: assets/logo.svg
favicon: assets/logo.svg
name: material
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- navigation.instant
- navigation.instant.progress
- content.tabs.link
- content.footnote.tooltips
palette:
- scheme: slate
toggle:
icon: material/weather-night
name: Switch to system preference
primary: brown
accent: deep orange
- scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
primary: brown
accent: deep orange
language: en
extra:
homepage: /overview/overview
alternate:
- name: Spanish
link: /es/
lang: es
- name: Catalan
link: /ca/
lang: ca
- name: Chinese
link: /zh/
lang: zh
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
- attr_list
- md_in_html
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- toc:
permalink: "#"
- footnotes
- tables
plugins:
- search
- mkdocstrings:
handlers:
python:
selection:
docstring_style: sphinx
rendering:
show_root_heading: false
show_root_toc_entry: false
heading_level: 3
show_object_full_path: true
show_signature_annotations: true
docstring_section_style: list
merge_init_into_class: true
nav:
- Overview:
- Overview: index.md
- Why?: overview/why.md
- What?: overview/what.md
- How?: overview/how.md
- What not?: overview/what_not.md
- References: overview/references.md
- Examples:
- Examples: examples.md
- Script Development: examples/developing_scripts.md
- Automatic testing - CI/CD: examples/automatic_testing.md
- Usage:
- Installation: usage/installation.md
- Getting Started: usage/getting_started.md
- Inventory: usage/fakenos_inventory.md
- Running in Docker Container: usage/running_in_docker.md
- Platforms: platforms.md
- Development:
- Main: development.md
- Conventions: development/conventions.md
- Tasks: development/tasks.md
- Creating a new platform: development/creating_new_platforms.md
- Creating NOS Plugin: development/creating_nos_plugin.md
- Collaborators:
- Collaborators: collaborators.md
- API Reference:
- Core API: core_api_reference.md
- Built-in Plugins API: builtin_plugins_api_reference.md