mkdocstrings-github 0.6.1__py3-none-any.whl → 0.6.2__py3-none-any.whl

{mkdocstrings_github-0.6.1.dist-info → mkdocstrings_github-0.6.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-github
-Version: 0.6.1
+Version: 0.6.2
 Summary: A GitHub Action handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -22,7 +22,7 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
 Requires-Dist: gitpython<4,>=3.1.45
-Requires-Dist: mkdocstrings<1,>=0.29
+Requires-Dist: mkdocstrings<2,>=1
 Requires-Dist: ruamel-yaml<1,>=0.18.16
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown

{mkdocstrings_github-0.6.1.dist-info → mkdocstrings_github-0.6.2.dist-info}/RECORD

@@ -1,6 +1,6 @@
 mkdocstrings_handlers/github/__init__.py,sha256=0WdFUIq4Xu2ZFtlZNIYCQSoqcx3Ot9Wv41_X_dwbFww,248
 mkdocstrings_handlers/github/config.py,sha256=r7efiI-vKbVEeD6utrc55h4RP6VIlabqDebhiIIx_ZA,7120
-mkdocstrings_handlers/github/handler.py,sha256=SQcd08VA3g4f3Fof2mam85ahPLiK99TteAJJpUg-iB4,8489
+mkdocstrings_handlers/github/handler.py,sha256=4El8kAupC4np2lwzvvMHi9AyHzeT4D6f8eUJO0RfKxY,8781
 mkdocstrings_handlers/github/objects.py,sha256=v1GchB9fzqasnXbVEOXoDzOR2iVTwcfPQ9mFT4sdjgs,7625
 mkdocstrings_handlers/github/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/github/rendering.py,sha256=pFk621Fqp_R6ZS2dJ0zwEEez0Urqpekial6kqKYDag8,3371
@@ -12,7 +12,7 @@ mkdocstrings_handlers/github/templates/material/outputs.html.jinja,sha256=Z9QD1K
 mkdocstrings_handlers/github/templates/material/secrets.html.jinja,sha256=jQ_HaG2ivbZTH74pyV4BAFGQu5Vn03kA_vaEbTSABds,2839
 mkdocstrings_handlers/github/templates/material/style.css,sha256=Nfmds-xHtPJ_IzOv5svA7ih5talHDTiQryN_n0DGdZs,1553
 mkdocstrings_handlers/github/templates/material/workflow.html.jinja,sha256=5dLdHRSQyulyFAVCVZAR_pkw-WXxCtM20cj6RS7IH1Q,4206
-mkdocstrings_github-0.6.1.dist-info/METADATA,sha256=fdZ69Xer6TQ4ZpkPnzyv1P2H2eE5KLi27DltQAJWNqA,4055
-mkdocstrings_github-0.6.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_github-0.6.1.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
-mkdocstrings_github-0.6.1.dist-info/RECORD,,
+mkdocstrings_github-0.6.2.dist-info/METADATA,sha256=-q58ad0sFPB7UkECg2UhNPKaCDRnYSU34mqQOlmIrLc,4052
+mkdocstrings_github-0.6.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mkdocstrings_github-0.6.2.dist-info/licenses/LICENSE,sha256=5enZtJ4zSp0Ps3jTqFQ4kadcx62BhgTaDNPrXWb3g3E,1069
+mkdocstrings_github-0.6.2.dist-info/RECORD,,

{mkdocstrings_github-0.6.1.dist-info → mkdocstrings_github-0.6.2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

mkdocstrings_handlers/github/handler.py

@@ -179,7 +179,10 @@ class GitHubHandler(BaseHandler):
         self.env.globals["repository_name"] = self.get_repository_name()
 
     def collect(self, identifier: str, options: GitHubOptions) -> Workflow | Action | None:
-        path = Path(self.repo.working_tree_dir) / identifier
+        working_tree_dir = self.repo.working_tree_dir
+        if working_tree_dir is None:
+            raise CollectionError("Repository working tree directory is not available.")
+        path = Path(working_tree_dir) / identifier
 
         if path.suffix in (".yml", ".yaml"):
             if not path.is_file():
@@ -199,12 +202,15 @@ class GitHubHandler(BaseHandler):
             )
         return data
 
-    def render(self, data: Workflow | Action, options: GitHubOptions) -> str:
+    def render(
+        self, data: Workflow | Action, options: GitHubOptions, *, locale: str | None = None
+    ) -> str:
         """Render a template using provided data and configuration options.
 
         Arguments:
             data: The collected data to render.
             options: The handler's configuration options.
+            locale: The locale to use for rendering (unused in this handler).
 
         Returns:
             The rendered template as HTML.