mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-08-17 04:30:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed 594c068 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2024-12-03 11:33:17 +00:00
parent b658c5b4e8
commit 027fee8296
54 changed files with 139 additions and 142 deletions
Download patch file Download diff file Expand all files Collapse all files

83
dev/scripts/reference.py
View file

@ -36,7 +36,6 @@ we don't have to run it manually. It will be run each time mkdocs is built.
"""
import inspect
import os
import re
import sys
from argparse import ArgumentParser
@ -59,16 +58,14 @@ from django_components.util.misc import get_import_path
# - By default we can't do relative imports (e.g. `.extensions`)
# - We can't import from packages found in the `src` directory (e.g. `docs.scripts.extensions`)
#
# But we need to import from another module.
# Hence we add the `src` directory to `sys.path` ourselves, so we can import from the
# `docs.scripts.extensions` module.
current_dir = os.path.dirname(os.path.abspath(__file__))
src_dir = os.path.abspath(os.path.join(current_dir, "..", ".."))
sys.path.insert(0, src_dir)
# But we need to import from another module in ./docs/scripts.
# Hence we add the directory of this file to `sys.path` ourselves.
from docs.scripts.extensions import _format_source_code_html # noqa: E402
current_dir = str(Path(__file__).parent)
sys.path.append(current_dir)
from extensions import _format_source_code_html # noqa: E402
root = Path(__file__).parent.parent.parent.parent
root = Path(__file__).parent.parent.parent
def gen_reference_api():
@ -81,11 +78,11 @@ def gen_reference_api():
module = import_module("django_components")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_api.md").read_text()
out_file = root / "src/docs/reference/api.md"
preface += (root / "docs/templates/reference_api.md").read_text()
out_file = root / "docs/reference/api.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for name, obj in inspect.getmembers(module):
@ -118,11 +115,11 @@ def gen_reference_exceptions():
module = import_module("django_components")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_exceptions.md").read_text()
out_file = root / "src/docs/reference/exceptions.md"
preface += (root / "docs/templates/reference_exceptions.md").read_text()
out_file = root / "docs/reference/exceptions.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for name, obj in inspect.getmembers(module):
@ -153,11 +150,11 @@ def gen_reference_components():
module = import_module("django_components.components")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_components.md").read_text()
out_file = root / "src/docs/reference/components.md"
preface += (root / "docs/templates/reference_components.md").read_text()
out_file = root / "docs/reference/components.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for name, obj in inspect.getmembers(module):
@ -203,11 +200,11 @@ def gen_reference_settings():
module = import_module("django_components.app_settings")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_settings.md").read_text()
out_file = root / "src/docs/reference/settings.md"
preface += (root / "docs/templates/reference_settings.md").read_text()
out_file = root / "docs/reference/settings.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
# 1. Insert section from `reference_settings.md`
f.write(preface + "\n\n")
@ -260,7 +257,7 @@ def _get_unique_methods(base_class: Type, sub_class: Type):
def _gen_default_settings_section(app_settings_filepath: str) -> str:
# In the soure code (`app_settings.py`), we've inserted following strings
# In the source code (`app_settings.py`), we've inserted following strings
# to mark the start and end of the where we define the default settings.
# We copy this as a plain string, so that the comments are preserved.
settings_sourcecode = Path(app_settings_filepath).read_text()
@ -308,11 +305,11 @@ def gen_reference_middlewares():
module = import_module("django_components.middleware")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_middlewares.md").read_text()
out_file = root / "src/docs/reference/middlewares.md"
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") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for name, obj in inspect.getmembers(module):
@ -351,8 +348,8 @@ def gen_reference_tagformatters():
module = import_module("django_components")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_tagformatters.md").read_text()
out_file = root / "src/docs/reference/tag_formatters.md"
preface += (root / "docs/templates/reference_tagformatters.md").read_text()
out_file = root / "docs/reference/tag_formatters.md"
tag_formatter_classes: Dict[str, Type[TagFormatterABC]] = {}
tag_formatter_instances: Dict[str, TagFormatterABC] = {}
@ -363,10 +360,10 @@ def gen_reference_tagformatters():
tag_formatter_classes[name] = obj
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
# Generate a summary of avilable tag formatters.
# Generate a summary of available tag formatters.
# For each pre-defined TagFormatter entry, generate e.g.
# ```markdown
# - `django_components.component_formatter` for [ComponentFormatter](#django_components.ComponentFormatter)
@ -414,13 +411,13 @@ def gen_reference_urls():
module = import_module("django_components.urls")
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_urls.md").read_text()
out_file = root / "src/docs/reference/urls.md"
preface += (root / "docs/templates/reference_urls.md").read_text()
out_file = root / "docs/reference/urls.md"
all_urls = _list_urls(module.urlpatterns)
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
# Simply list all URLs, e.g.
@ -442,11 +439,11 @@ def gen_reference_commands():
]
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_commands.md").read_text()
out_file = root / "src/docs/reference/commands.md"
preface += (root / "docs/templates/reference_commands.md").read_text()
out_file = root / "docs/reference/commands.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for cmd_name, cmd_path in command_modules:
@ -459,7 +456,7 @@ def gen_reference_commands():
formatted_args = _format_command_args(cmd_parser)
# Add link to source code
module_rel_path = Path(cmd_module.__file__).relative_to(Path.cwd()) # type: ignore[arg-type]
module_rel_path = Path(cmd_module.__file__).relative_to(Path.cwd()).as_posix() # type: ignore[arg-type]
obj_lineno = inspect.findsource(cmd_cls)[1]
source_code_link = _format_source_code_html(module_rel_path, obj_lineno)
@ -490,16 +487,16 @@ def gen_reference_templatetags():
]
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_templatetags.md").read_text()
out_file = root / "src/docs/reference/template_tags.md"
preface += (root / "docs/templates/reference_templatetags.md").read_text()
out_file = root / "docs/reference/template_tags.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for mod_name, mod_path in tags_modules:
tags_module = import_module(mod_path)
module_rel_path = Path(tags_module.__file__).relative_to(Path.cwd()) # type: ignore[arg-type]
module_rel_path = Path(tags_module.__file__).relative_to(Path.cwd()).as_posix() # type: ignore[arg-type]
f.write(
f"All following template tags are defined in\n\n"
@ -543,11 +540,11 @@ def gen_reference_templatevars():
under the `{{ component_vars }}` variable, as defined by `ComponentVars`.
"""
preface = "<!-- Autogenerated by reference.py -->\n\n"
preface += (root / "src/docs/templates/reference_templatevars.md").read_text()
out_file = root / "src/docs/reference/template_vars.md"
preface += (root / "docs/templates/reference_templatevars.md").read_text()
out_file = root / "docs/reference/template_vars.md"
out_file.parent.mkdir(parents=True, exist_ok=True)
with out_file.open("w") as f:
with out_file.open("w", encoding="utf-8") as f:
f.write(preface + "\n\n")
for field in ComponentVars._fields: