mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-09-20 12:49:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed 6253042 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2025-05-06 19:37:57 +00:00
parent 2265eb83f7
commit 3783055886
74 changed files with 895 additions and 943 deletions
Download patch file Download diff file Expand all files Collapse all files

46
dev/scripts/reference.py
View file

@ -1,6 +1,6 @@
"""
Generate reference for all the different kinds of public API that we expose,
like regular Python imports, middleware, template tags, settings, Django URLs, etc.
like regular Python imports, template tags, settings, Django URLs, etc.
All pages are generated inside `docs/reference/`.
@ -338,49 +338,6 @@ def _gen_default_settings_section(app_settings_filepath: str) -> str:
)
def gen_reference_middlewares():
"""
Generate documentation for all available middleware of django-components,
as listed in module `django_components.middleware`.
"""
module = import_module("django_components.middleware")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "docs/templates/reference_middlewares.md").read_text()
out_file = root / "docs/reference/middlewares.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for name, obj in inspect.getmembers(module):
if not inspect.isclass(obj):
continue
class_name = get_import_path(obj)
# For each entry, generate a mkdocstrings entry, e.g.
# ```
# ::: django_components.middleware.ComponentDependencyMiddleware
# options:
# ...
# ```
f.write(
f"::: {class_name}\n"
f" options:\n"
f" inherited_members: false\n"
f" show_root_heading: true\n"
f" show_signature: false\n"
f" separate_signature: false\n"
f" show_symbol_type_heading: false\n"
f" show_symbol_type_toc: false\n"
f" show_if_no_docstring: true\n"
f" show_labels: false\n"
)
f.write("\n")
def gen_reference_tagformatters():
"""
Generate documentation for all pre-defined TagFormatters included
@ -1145,7 +1102,6 @@ def gen_reference():
gen_reference_api()
gen_reference_exceptions()
gen_reference_components()
gen_reference_middlewares()
gen_reference_settings()
gen_reference_tagformatters()
gen_reference_urls()