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

Deployed a3710fe to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2024-12-02 10:13:02 +00:00
parent ddd32a9ab2
commit df59e4326f
65 changed files with 1042 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

30
dev/scripts/reference.py
View file

@ -80,7 +80,8 @@ def gen_reference_api():
"""
module = import_module("django_components")
preface = (root / "src/docs/templates/reference_api.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -116,7 +117,8 @@ def gen_reference_exceptions():
"""
module = import_module("django_components")
preface = (root / "src/docs/templates/reference_exceptions.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -150,7 +152,8 @@ def gen_reference_components():
"""
module = import_module("django_components.components")
preface = (root / "src/docs/templates/reference_components.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -199,7 +202,8 @@ def gen_reference_settings():
"""
module = import_module("django_components.app_settings")
preface = (root / "src/docs/templates/reference_settings.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -303,7 +307,8 @@ def gen_reference_middlewares():
"""
module = import_module("django_components.middleware")
preface = (root / "src/docs/templates/reference_middlewares.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -345,7 +350,8 @@ def gen_reference_tagformatters():
"""
module = import_module("django_components")
preface = (root / "src/docs/templates/reference_tagformatters.md").read_text()
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"
tag_formatter_classes: Dict[str, Type[TagFormatterABC]] = {}
@ -407,7 +413,8 @@ def gen_reference_urls():
"""
module = import_module("django_components.urls")
preface = (root / "src/docs/templates/reference_urls.md").read_text()
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"
all_urls = _list_urls(module.urlpatterns)
@ -434,7 +441,8 @@ def gen_reference_commands():
if not p.stem.startswith("_")
]
preface = (root / "src/docs/templates/reference_commands.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -481,7 +489,8 @@ def gen_reference_templatetags():
(p.stem, f"django_components.templatetags.{p.stem}") for p in tags_files if not p.stem.startswith("_")
]
preface = (root / "src/docs/templates/reference_templatetags.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)
@ -533,7 +542,8 @@ def gen_reference_templatevars():
Generate documentation for all variables that are available inside the component templates
under the `{{ component_vars }}` variable, as defined by `ComponentVars`.
"""
preface = (root / "src/docs/templates/reference_templatevars.md").read_text()
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"
out_file.parent.mkdir(parents=True, exist_ok=True)