mirror of
https://github.com/inventree/InvenTree.git
synced 2026-11-14 20:42:42 +00:00
[docs] Zensical docs (#13253)
* add zensical workflow * rebuild schema dynamically * load in new module * Use zensical for docs invoke tasks * modern * improved carousel layout * Increased content width * fix for app icons * Ensure schema dir exists * remove unused requirement * update readthedocs process * fix polar.sh link * adjust link checker pattern * Revert some of the original style * remove legacy mkdocs requirements * fix for ready.py * reduce db warnings during schema generation * Adjust padding * fix index issues * fix page title * fix pages with broken or missing headers * split data import API schema * cleanup old carousel * remove djlint link
This commit is contained in:
1 parent
80ad822688
commit
19dfb81bfb
52 files changed
+1272
-4885
No files matched your search
+17
-21
@@ -1,5 +1,14 @@
|
||||
# Documentation is built with Zensical (https://zensical.org), which reads this
|
||||
# mkdocs-format config. Build from the repo root with "invoke build-docs --build"
|
||||
# (or "zensical build -f docs/mkdocs.yml" after running "invoke build-docs").
|
||||
#
|
||||
# Zensical does not run mkdocs hooks, so:
|
||||
# - the values from docs/docs/hooks.py:on_config are injected by docs/main.py
|
||||
# - the post-build checks (hooks.py:on_post_build) are run by "invoke build-docs"
|
||||
# - site_url is taken from READTHEDOCS_CANONICAL_URL when building on ReadTheDocs
|
||||
|
||||
# Project
|
||||
site_url: https://inventree.readthedocs.io
|
||||
site_url: !ENV [READTHEDOCS_CANONICAL_URL, 'https://docs.inventree.org/']
|
||||
site_name: InvenTree Documentation
|
||||
site_description: InvenTree - Open Source Inventory Management
|
||||
site_author: InvenTree
|
||||
@@ -12,8 +21,7 @@ repo_name: inventree/inventree
|
||||
# Theme
|
||||
theme:
|
||||
name: material
|
||||
font:
|
||||
text: Roboto
|
||||
variant: modern
|
||||
custom_dir: _includes/overrides
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
@@ -39,7 +47,7 @@ theme:
|
||||
- header.autohide
|
||||
- navigation.expand
|
||||
- navigation.footer
|
||||
- navigation.indexes
|
||||
# - navigation.indexes
|
||||
- navigation.instant
|
||||
# - navigation.sections
|
||||
- navigation.tracking
|
||||
@@ -54,10 +62,10 @@ extra_css:
|
||||
- stylesheets/brands.css
|
||||
- stylesheets/regular.css
|
||||
- stylesheets/solid.css
|
||||
- stylesheets/fontawesome-svg.css
|
||||
- stylesheets/bootstrap.css
|
||||
- stylesheets/splide.min.css
|
||||
- stylesheets/extra.css
|
||||
- stylesheets/neoteroi-mkdocs.css
|
||||
- https://cdn.jsdelivr.net/npm/@tabler/icons-webfont@3.31.0/dist/tabler-icons.min.css
|
||||
extra_javascript:
|
||||
- javascripts/extra.js
|
||||
@@ -203,7 +211,6 @@ nav:
|
||||
- Multi Factor Authentication: settings/MFA.md
|
||||
- SCIM Provisioning: settings/SCIM.md
|
||||
- Email Settings: settings/email.md
|
||||
- Experimental Features: settings/experimental.md
|
||||
- Operations:
|
||||
- Background Tasks: settings/tasks.md
|
||||
- Error Logs: settings/logs.md
|
||||
@@ -304,22 +311,10 @@ nav:
|
||||
|
||||
# Plugins
|
||||
plugins:
|
||||
- neoteroi.mkdocsoad:
|
||||
use_pymdownx: true
|
||||
- include-markdown:
|
||||
opening_tag: "{!"
|
||||
closing_tag: "!}"
|
||||
- search
|
||||
- mermaid2:
|
||||
# version: 11.6.0
|
||||
javascript: javascripts/mermaid.min.js
|
||||
- git-revision-date-localized
|
||||
- mkdocs-simple-hooks:
|
||||
hooks:
|
||||
on_config: "docs.docs.hooks:on_config"
|
||||
on_post_build: "docs.docs.hooks:on_post_build"
|
||||
- macros:
|
||||
include_dir: docs/_includes
|
||||
include_dir: _includes
|
||||
on_error_fail: true
|
||||
module_name: main
|
||||
- mkdocstrings:
|
||||
default_handler: python
|
||||
@@ -366,7 +361,7 @@ markdown_extensions:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
class: mermaid
|
||||
format: !!python/name:mermaid2.fence_mermaid_custom
|
||||
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
|
||||
@@ -412,3 +407,4 @@ extra:
|
||||
|
||||
use_directory_urls: true
|
||||
strict: true
|
||||
site_dir: site
|
||||
Reference in new issue
Block a user