forked from inventree/inventree-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
200 lines (191 loc) · 5.75 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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# Project
site_url: https://inventree.readthedocs.io
site_name: InvenTree Documentation
site_description: InvenTree - Open Source Inventory Management
site_author: InvenTree
# Repository
repo_url: https://github.com/inventree/inventree-docs
repo_name: inventree/inventree-docs
# Theme
theme:
name: material
custom_dir: _includes/overrides
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
accent: light blue
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: light blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to light mode
logo: assets/logo.png
favicon: assets/favicon.ico
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- toc.autohide
edit_uri: "" # Disable "Edit" button
extra_css:
- stylesheets/extra.css
- stylesheets/brands.css
- stylesheets/regular.css
- stylesheets/solid.css
- stylesheets/bootstrap.css
- stylesheets/splide.min.css
extra_javascript:
- javascripts/extra.js
- javascripts/fontawesome.js
- javascripts/brands.js
- javascripts/regular.js
- javascripts/solid.js
- javascripts/splide.min.js
- https://code.jquery.com/jquery-3.6.0.js
- https://maxcdn.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.js
# Navigation
nav:
- InvenTree:
- Features: features.md
- Release Notes: releases/release_notes.md
- Demo: demo.md
- FAQ: faq.md
- Contribute: contribute.md
- Credits: credits.md
- Privacy: privacy.md
- Terminology: terminology.md
- Install:
- Introduction: start/intro.md
- Configuration: start/config.md
- Docker Setup: start/docker.md
- Bare Metal Setup: start/install.md
- Updating: start/update.md
- Migrating: start/migrate.md
- Parts:
- Parts: part/part.md
- Creating Parts: part/create.md
- Part Views: part/views.md
- Tracking: part/trackable.md
- Parameters: part/parameter.md
- Templates: part/template.md
- Tests: part/test.md
- Pricing: part/pricing.md
- Notifications: part/notification.md
- Stock:
- Stock Items: stock/stock.md
- Stock Status: stock/status.md
- Adjusting Stock: stock/adjust.md
- Stock Expiry: stock/expiry.md
- Stock Ownership: stock/owner.md
- Test Results: stock/test.md
- Build:
- Build Orders: build/build.md
- Bill of Materials: build/bom.md
- Allocating Stock: build/allocate.md
- Companies:
- Suppliers: companies/supplier.md
- Manufacturers: companies/manufacturer.md
- Customers: companies/customer.md
- Purchase Orders: companies/po.md
- Sales Orders: companies/so.md
- Report:
- Templates: report/report.md
- Labels: report/labels.md
- Reports:
- Test Reports: report/test.md
- Packing List: report/pack.md
- Build Order: report/build.md
- Order: report/order.md
- BOM: report/bom.md
- Barcodes: report/barcodes.md
- Context Variables: report/context_variables.md
- Admin:
- Global Settings: settings/global.md
- User Settings: settings/user.md
- Admin Interface: settings/admin.md
- User Permissions: settings/permissions.md
- Single Sign on: settings/SSO.md
- Multi Factor Authentication: settings/MFA.md
- Export Data: settings/export.md
- Import Data: settings/import.md
- Python Shell: settings/shell.md
- Error Logs: settings/logs.md
- Email: settings/email.md
- Background Tasks: settings/tasks.md
- Extend:
- Plugins:
- Overview: extend/plugins.md
- How To: extend/how_to_plugin.md
- Action Mixin: extend/plugins/action.md
- API Mixin: extend/plugins/api.md
- App Mixin: extend/plugins/app.md
- Barcode Mixin: extend/plugins/barcode.md
- Event Mixin: extend/plugins/event.md
- Label Printing Mixin: extend/plugins/label.md
- Navigation Mixin: extend/plugins/navigation.md
- Schedule Mixin: extend/plugins/schedule.md
- Settings Mixin: extend/plugins/settings.md
- URL Mixin: extend/plugins/urls.md
- API: extend/api.md
- Python Interface: extend/python.md
- Themes: extend/themes.md
- Third-Party: extend/integrate.md
- App:
- InvenTree App: app/app.md
- Connect: app/connect.md
- Barcodes: app/barcode.md
- Parts: app/part.md
- Stock: app/stock.md
- Purchase Orders: app/po.md
- Settings: app/settings.md
- Privacy: app/privacy.md
- Release Notes: app/release.md
- Translation: app/translation.md
- Suggestions: app/issues.md
# Plugins
plugins:
- search
- git-revision-date-localized
- mkdocs-simple-hooks:
hooks:
on_config: "docs.hooks:on_config"
- macros:
include_dir: _includes
# Extensions
markdown_extensions:
- admonition
- attr_list
- meta
- pymdownx.details
- pymdownx.highlight
- pymdownx.superfences
# - pymdownx.emoji:
# emoji_index: !!python/name:materialx.emoji.twemoji
# emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
permalink: true
# Global Variables
extra:
static_folder_source: ./InvenTree/InvenTree/static/
static_folder_local_default: ./inventree_static/
# Site Analytics
# See https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-analytics/
# analytics:
# provider: google
# property: UA-143467500-1
social:
- icon: fontawesome/brands/github
link: https://github.com/inventree/inventree
name: InvenTree on GitHub
- icon: fontawesome/brands/twitter
link: https://twitter.com/inventreedb
name: InvenTree on Twitter
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/inventree/inventree
name: InvenTree on Docker
use_directory_urls: true
strict: true