hippogriffe 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

hippogriffe/_extension.py

@@ -92,7 +92,7 @@ class _PublicApi:
                 if isinstance(member, griffe.Alias):
                     try:
                         final_member = member.final_target
-                    except griffe.AliasResolutionError:
+                    except (griffe.AliasResolutionError, griffe.CyclicAliasError):
                         continue
                     if member.name != final_member.name:
                         # Renaming during import counts as private.
@@ -268,12 +268,15 @@ def _get_repo_url(repo_url: None | str) -> tuple[pathlib.Path, str]:
     else:
         toplevel = pathlib.Path(git_toplevel.stdout.decode().strip())
         commit_hash = git_head.stdout.decode().strip()
-    raw_url = repo_url.removeprefix("https://").removeprefix("https://")
-    if raw_url.startswith("github.com") or raw_url.startswith("gitlab.com"):
-        repo_url = (
-            f"{repo_url.removesuffix('/')}/blob/{commit_hash}/{{path}}"
-            "#L{start}-{end}"
-        )
+    if "://" in repo_url:
+        protocol, repo_url = repo_url.split("://", 1)
+        protocol = f"{protocol}://"
+    else:
+        protocol = ""
+    if repo_url.startswith("github.com"):
+        fragment = "L{start}-L{end}"
+    elif repo_url.startswith("gitlab.com"):
+        fragment = "L{start}-{end}"
     else:
         # We need to format the `repo_url` to what the repo expects, so we have to
         # hardcode this in.
@@ -281,6 +284,9 @@ def _get_repo_url(repo_url: None | str) -> tuple[pathlib.Path, str]:
             "`hippogriffe.show_source_links` currently only supports "
             "`repo_url: https://github.com/...` and `repo_url: https://gitlab.com/...`."
         )
+    # Expect url in the form `https://github.com/org/repo`, strip any trailing paths
+    repo_url = "/".join(repo_url.split("/")[:3])
+    repo_url = f"{protocol}{repo_url}/blob/{commit_hash}/{{path}}#{fragment}"
     return toplevel, repo_url
 
 
@@ -351,7 +357,11 @@ class HippogriffeExtension(griffe.Extension):
                 with contextlib.suppress(BaseException):
                     obj = eval(obj, context)
             # Then if it's in the public API, convert it over.
-            if isinstance(obj, type) and obj is not type(None):
+            if (
+                isinstance(obj, type)
+                and obj is not type(None)
+                and not hasattr(obj, "__pdoc__")
+            ):
                 new_path, _ = public_api[f"{obj.__module__}.{obj.__qualname__}"]
                 return wl.TextDoc(new_path)
 

{hippogriffe-0.2.0.dist-info → hippogriffe-0.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hippogriffe
-Version: 0.2.0
+Version: 0.2.2
 Summary: Tweaks for `mkdocstrings[python]`
 Project-URL: repository, https://github.com/patrick-kidger/hippogriffe
 Author-email: Patrick Kidger <contact@kidger.site>
@@ -295,4 +295,4 @@ plugins:
             - torch.Tensor
 ```
 
-List each object under whatever public path `somelib.Foo` that you would like it to be displayed under (and from which it must be accessilbe), not whatever private path `somelib._internal.foo.Foo` it is defined at.
+List each object under whatever public path `somelib.Foo` that you would like it to be displayed under (and from which it must be accessible), not whichever private path `somelib._internal.foo.Foo` it is defined at.

{hippogriffe-0.2.0.dist-info → hippogriffe-0.2.2.dist-info}/RECORD

@@ -1,12 +1,12 @@
 hippogriffe/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hippogriffe/_extension.py,sha256=5c5Hb4qW4v3UjGn2x2MwXB_8CI6PfLUOQ0kO0soflA0,15992
+hippogriffe/_extension.py,sha256=d60NW7VnWolEKYF-62WUp9o4RAviB3eXnHUC2zQJCWI,16352
 hippogriffe/_plugin.py,sha256=9omje-ROpvo24YYSIcul8XjKwuzFhV7rE9a1f3XDUws,4307
 hippogriffe/assets/_hippogriffe.css,sha256=BgyZLCaOaZNgQErdUb01vpNso4ilUMmoZ5d_OeVpfRE,147
 hippogriffe/templates/material/hippogriffe/class.html.jinja,sha256=5i624gIuZfnf5toH3jWclzg1qlekqIZ2ODbpzeZcULw,954
 hippogriffe/templates/material/hippogriffe/fn.html.jinja,sha256=vxrWOPkPkGD3Po9hbcYlyEjsJKhJmOHic4G5t2J0djc,196
 hippogriffe/templates/material/hippogriffe/hippogriffe.jinja,sha256=KxTBKY0XqiFzqTT1iqFxhN2GhmtwLT4GWc8S86zyjOc,583
-hippogriffe-0.2.0.dist-info/METADATA,sha256=Ud_6bXxxqtLRQltCwOPUzH2MfpzAHDcNCeWMfOrpTu8,16449
-hippogriffe-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-hippogriffe-0.2.0.dist-info/entry_points.txt,sha256=Et3dFNWG-biZ7XCvPI9na-buFT_hht1YT0p0JDNEQQM,158
-hippogriffe-0.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-hippogriffe-0.2.0.dist-info/RECORD,,
+hippogriffe-0.2.2.dist-info/METADATA,sha256=LI0Hi2TiM-0WwREciAuktiduV-u50M8otJwMmlkE7r4,16450
+hippogriffe-0.2.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+hippogriffe-0.2.2.dist-info/entry_points.txt,sha256=Et3dFNWG-biZ7XCvPI9na-buFT_hht1YT0p0JDNEQQM,158
+hippogriffe-0.2.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+hippogriffe-0.2.2.dist-info/RECORD,,