Skip to content

Commit 904a89b

Browse files
committed
chore: Allow no-op use
1 parent 5f5f9ed commit 904a89b

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

src/mkdocstrings_handlers/javascript/handler.py

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ def collect(self, identifier: str, config: MutableMapping[str, Any]) -> Collecto
6565
Returns:
6666
Anything you want, as long as you can feed it to the `render` method.
6767
"""
68-
raise CollectionError("Implement me!")
68+
return {"identifier": identifier}
6969

7070
def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa: ARG002
7171
"""Render a template using provided data and configuration options.
@@ -78,13 +78,10 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str: # noqa
7878
Returns:
7979
The rendered template as HTML.
8080
"""
81-
# final_config = {**self.default_config, **config}
82-
# heading_level = final_config["heading_level"]
83-
# template = self.env.get_template(f"{data...}.html.jinja")
84-
# return template.render(
85-
# **{"config": final_config, data...: data, "heading_level": heading_level, "root": True},
86-
# )
87-
raise PluginError("Implement me!")
81+
return (
82+
f"<i><b><code>::: {data['identifier']}</code></b><br>The public version of mkdocstrings-javascript is a no-op "
83+
"and exist only to allow building docs without errors. Please rely on docs preview in CI.</i>"
84+
)
8885

8986
def update_env(self, md: Markdown, config: dict) -> None:
9087
"""Update the Jinja environment with any custom settings/filters/options for this handler.

0 commit comments

Comments
 (0)