mirrors/django-components
1
0
Fork 0
mirror of https://github.com/django-components/django-components.git synced 2025-09-22 21:52:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Deployed f100cc18 to dev with MkDocs 1.6.1 and mike 2.1.3

Browse source
This commit is contained in:
github-actions 2025-09-10 12:08:25 +00:00
parent d7c0bf40c5
commit b4b5f972ff
79 changed files with 547 additions and 725 deletions
Download patch file Download diff file Expand all files Collapse all files

14
dev/scripts/mkdocs_util.py
View file

@ -3,22 +3,22 @@
from functools import lru_cache
from importlib import import_module
from pathlib import Path
from typing import Dict, List, Optional, Union
from typing import Any, Dict, List, Optional, Union
import griffe
import yaml # type: ignore[import-untyped]
@lru_cache()
@lru_cache
def load_config() -> Dict:
mkdocs_config_str = Path("mkdocs.yml").read_text()
# NOTE: Use BaseLoader to avoid resolving tags like `!ENV`
# See https://stackoverflow.com/questions/45966633/yaml-error-could-not-determine-a-constructor-for-the-tag
mkdocs_config = yaml.load(mkdocs_config_str, yaml.BaseLoader)
mkdocs_config = yaml.load(mkdocs_config_str, yaml.BaseLoader) # noqa: S506
return mkdocs_config
@lru_cache()
@lru_cache
def find_plugin(name: str) -> Optional[Dict]:
config = load_config()
plugins: List[Union[str, Dict[str, Dict]]] = config.get("plugins", [])
@ -27,8 +27,8 @@ def find_plugin(name: str) -> Optional[Dict]:
for plugin in plugins:
if isinstance(plugin, str):
plugin = {plugin: {}}
plugin_name, plugin_conf = list(plugin.items())[0]
plugin = {plugin: {}} # noqa: PLW2901
plugin_name, plugin_conf = next(iter(plugin.items()))
if plugin_name == name:
return plugin_conf
@ -43,7 +43,7 @@ def get_mkdocstrings_plugin_handler_options() -> Optional[Dict]:
return plugin.get("handlers", {}).get("python", {}).get("options", {})
def import_object(obj: griffe.Object):
def import_object(obj: griffe.Object) -> Any:
module = import_module(obj.module.path)
runtime_obj = getattr(module, obj.name)
return runtime_obj