[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:
Oliver authored and GitHub committed 2026-11-14 22:34:18 +11:00
1 parent 80ad822688
commit 19dfb81bfb
52 files changed
+1272 -4885

No files matched your search

+26 -6
View File
@@ -111,10 +111,14 @@ ARGV_COMMANDS: dict[str, tuple[str, ...]] = {
'schema',
'spectactular',
# schema adjacent calls
'export_settings_definitions',
'export_tags',
'export_audited_models',
'export_filters',
'export_fsm',
'export_report_context',
'export_roles',
'export_settings_definitions',
'export_status_codes',
'export_tags',
),
# Commands which must not touch the database during the app 'ready' phase
'database_excluded': (
@@ -188,14 +192,32 @@ def isCollectingPlugins():
return cmd_context['collect_plugins']
# Prefix of the RuntimeWarning Django emits when the database is queried before the app registry is ready
APPS_NOT_READY_WARNING_MSG = (
'Accessing the database during app initialization is discouraged'
)
# This variable is used to cache the result of the isGeneratingSchema function, to prevent multiple executions of the same checks
_IS_GENERATING_SCHEMA: bool | None = None
def _setGeneratingSchema(value: bool):
"""Set the value of the isGeneratingSchema variable."""
"""Set the value of the isGeneratingSchema variable.
When schema generation is detected, the Django 'APPS_NOT_READY' database warning
is suppressed for the remainder of the process. Schema generation (and the
'schema adjacent' export commands) intentionally query the database during model
import (e.g. to document custom status codes), so this warning is expected noise.
These are one-shot CLI processes, so a process-wide filter is safe here.
"""
global _IS_GENERATING_SCHEMA
_IS_GENERATING_SCHEMA = value
if value:
warnings.filterwarnings(
'ignore', message=APPS_NOT_READY_WARNING_MSG, category=RuntimeWarning
)
return value
@@ -360,9 +382,7 @@ def ignore_ready_warning(func):
def wrapper(*args, **kwargs):
with warnings.catch_warnings():
warnings.filterwarnings(
'ignore',
message='Accessing the database during app initialization is discouraged',
category=RuntimeWarning,
'ignore', message=APPS_NOT_READY_WARNING_MSG, category=RuntimeWarning
)
return func(*args, **kwargs)