hippogriffe 0.1.0__tar.gz

hippogriffe-0.1.0/.gitignore

@@ -0,0 +1,16 @@
+**/__pycache__
+**/.ipynb_checkpoints
+*.egg-info/
+build/
+dist/
+site/
+examples/data
+examples/CIFAR
+.all_objects.cache
+.pymon
+.idea
+examples/MNIST
+examples/multipart_serialised.eqx
+.python-version
+.DS_Store
+.venv

hippogriffe-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

hippogriffe-0.1.0/PKG-INFO

@@ -0,0 +1,294 @@
+Metadata-Version: 2.4
+Name: hippogriffe
+Version: 0.1.0
+Summary: A simple ipynb->md converter for MkDocs
+Project-URL: repository, https://github.com/patrick-kidger/hippogriffe
+Author-email: Patrick Kidger <contact@kidger.site>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+Keywords: griffe,markdown,md,mkdocs,mkdocstrings
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: griffe>=1.6.0
+Requires-Dist: mkdocs>=1.6.1
+Requires-Dist: mkdocstrings[python]>=0.28.3
+Requires-Dist: wadler-lindig>=0.1.4
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<h1 align="center">Hippogriffe</h1>
+
+This is a set of tweaks on top of the MkDocs + `mkdocstrings[python]` + `griffe` documentation stack. In particular, we:
+
+- Add `[source]` links to GitHub to each top-level class or function.
+- Pretty-format type annotations:
+    - Fixes unions/generics/etc. to display as e.g. `int | str` rather than just `Union`, or `tuple[int, str]` rather than just `tuple`.
+    - Respects your public API: if a type is declared in your documentation as `::: yourlib.Foo` then its usage in type annotations will match: `some_fn(foo: yourlib.Foo)`.
+- Show base classes inline after the class.
+
+Before                 | After
+:---------------------:|:----------------------:
+![old](./imgs/old.png) | ![new](./imgs/new.png)
+
+## Installation
+
+```bash
+pip install hippogriffe
+```
+
+Requires MkDocs 1.6.1+ and `mkdocstrings[python]` 0.28.3+
+
+## Usage
+
+In `mkdocs.yml`:
+```yml
+...
+
+plugins:
+    - hippogriffe
+    - mkdocstrings:
+        ...
+```
+
+## Configuration
+
+Hippogriffe supports the following configuration options:
+
+```yml
+plugins:
+    - hippogriffe:
+        show_bases: true/false
+        show_source_links: all/toplevel/none
+        extra_public_modules:
+            - foo
+            - bar
+```
+
+**show_bases:**
+
+If `false` then base classes will not be displayed alongside a class. Defaults to `true`.
+
+**show_source_links:**
+
+Sets which objects will have links to their location in the repository (as configured via the usual MkDocs `repo_url`). If `all` then all objects will have links. If `toplevel` then just `::: somelib.value` will have links, but their members will not. If `none` then no links will be added. Defaults to `toplevel`.
+
+**extra_public_modules:**
+
+A list of module names whose elements should be treated as part of the public API. Pretty-formatting of type annotations is done strictly: every annotation must be part of the known public API, else an error will be raised. The public API is defined as the combination of:
+
+- Everything you document using `::: yourlib.Foo`, and all of their members.
+- Anything from the standard library.
+- All objects belonging to any of `extra_public_modules`.
+
+For example,
+```yml
+plugins:
+    - hippogriffe:
+        extra_public_modules:
+            - jax
+            - torch
+```

hippogriffe-0.1.0/README.md

@@ -0,0 +1,72 @@
+<h1 align="center">Hippogriffe</h1>
+
+This is a set of tweaks on top of the MkDocs + `mkdocstrings[python]` + `griffe` documentation stack. In particular, we:
+
+- Add `[source]` links to GitHub to each top-level class or function.
+- Pretty-format type annotations:
+    - Fixes unions/generics/etc. to display as e.g. `int | str` rather than just `Union`, or `tuple[int, str]` rather than just `tuple`.
+    - Respects your public API: if a type is declared in your documentation as `::: yourlib.Foo` then its usage in type annotations will match: `some_fn(foo: yourlib.Foo)`.
+- Show base classes inline after the class.
+
+Before                 | After
+:---------------------:|:----------------------:
+![old](./imgs/old.png) | ![new](./imgs/new.png)
+
+## Installation
+
+```bash
+pip install hippogriffe
+```
+
+Requires MkDocs 1.6.1+ and `mkdocstrings[python]` 0.28.3+
+
+## Usage
+
+In `mkdocs.yml`:
+```yml
+...
+
+plugins:
+    - hippogriffe
+    - mkdocstrings:
+        ...
+```
+
+## Configuration
+
+Hippogriffe supports the following configuration options:
+
+```yml
+plugins:
+    - hippogriffe:
+        show_bases: true/false
+        show_source_links: all/toplevel/none
+        extra_public_modules:
+            - foo
+            - bar
+```
+
+**show_bases:**
+
+If `false` then base classes will not be displayed alongside a class. Defaults to `true`.
+
+**show_source_links:**
+
+Sets which objects will have links to their location in the repository (as configured via the usual MkDocs `repo_url`). If `all` then all objects will have links. If `toplevel` then just `::: somelib.value` will have links, but their members will not. If `none` then no links will be added. Defaults to `toplevel`.
+
+**extra_public_modules:**
+
+A list of module names whose elements should be treated as part of the public API. Pretty-formatting of type annotations is done strictly: every annotation must be part of the known public API, else an error will be raised. The public API is defined as the combination of:
+
+- Everything you document using `::: yourlib.Foo`, and all of their members.
+- Anything from the standard library.
+- All objects belonging to any of `extra_public_modules`.
+
+For example,
+```yml
+plugins:
+    - hippogriffe:
+        extra_public_modules:
+            - jax
+            - torch
+```

hippogriffe-0.1.0/hippogriffe/_extension.py

@@ -0,0 +1,350 @@
+import ast
+import builtins
+import contextlib
+import functools as ft
+import inspect
+import pathlib
+import re
+import subprocess
+import sys
+from collections.abc import Callable
+from typing import Any, Iterable, Iterator, Literal, get_origin
+
+import griffe
+import wadler_lindig as wl
+
+from ._plugin import PluginConfig
+
+
+_here = pathlib.Path(__file__).resolve().parent
+
+
+def get_templates_path():
+    return _here / "templates"
+
+
+class _PublicApi:
+    def __init__(
+        self,
+        pkg: griffe.Module,
+        top_level_public_api: set[str],
+        builtin_modules: list[str],
+        stdlib_modules: list[str],
+        extra_public_modules: list[str],
+    ):
+        self._objects: set[griffe.Object] = set()
+        self._toplevel_objects: set[griffe.Object] = set()
+        self._data: dict[str, list[str]] = {}
+        self._builtin_modules = builtin_modules
+        self._public_modules = stdlib_modules + extra_public_modules
+        seen: set[griffe.Alias | griffe.Object] = set()  # Don't infinite loop on cycles
+
+        agenda: list[tuple[griffe.Alias | griffe.Object, bool]] = [(pkg, False)]
+        while len(agenda) > 0:
+            item, force_public = agenda.pop()
+            seen.add(item)
+            # Skip private elements
+            if item.name.startswith("_") and not (
+                item.name.startswith("__") and item.name.endswith("__")
+            ):
+                continue
+            if isinstance(item, griffe.Alias):
+                try:
+                    final_item = item.final_target
+                except griffe.AliasResolutionError:
+                    continue
+                if item.name != final_item.name:
+                    # Renaming during import counts as private.
+                    # (In particular this happens for backward compatibility, e.g.
+                    # `equinox.nn.inference_mode` and `equinox.tree_inference`.)
+                    continue
+            else:
+                final_item = item
+
+            toplevel_public = item.path in top_level_public_api
+            if force_public or toplevel_public:
+                # If we're in the public API, then we consider all of our children to be
+                # in it as well... (this saves us from having to parse out `filters` and
+                # `members` from our documentation)
+                agenda.extend(
+                    (x, True) for x in item.all_members.values() if x not in seen
+                )
+                try:
+                    paths = self._data[final_item.path]
+                except KeyError:
+                    paths = self._data[final_item.path] = []
+                paths.append(item.path)
+                self._objects.add(final_item)
+                if toplevel_public:
+                    self._toplevel_objects.add(final_item)
+            else:
+                # ...if we're not in the public API then check our members -- some of
+                # them might be in the public API.
+                agenda.extend(
+                    (x, False) for x in item.all_members.values() if x not in seen
+                )
+
+    def toplevel(self) -> Iterable[griffe.Object]:
+        return self._toplevel_objects
+
+    def __iter__(self) -> Iterator[griffe.Object]:
+        yield from self._objects
+
+    def __getitem__(self, key: str) -> tuple[str, bool]:
+        try:
+            paths = self._data[key]
+        except KeyError as e:
+            for m in self._builtin_modules:
+                if key.startswith(m + "."):
+                    return key.removeprefix(m + "."), False
+            for m in self._public_modules:
+                if key.startswith(m + "."):
+                    return key, False
+            raise Exception(
+                f"Tried and failed to find {key} in the public API. Commons reasons "
+                "for this error are:\n"
+                "- If it is from outside this package, then that package is not listed "
+                "under the `hippogriffe.extra_public_modules`\n"
+                "- If it is from inside this package, then it may have been written "
+                "`::: somelib.Foo:` with a trailing colon, when just `:::somelib.Foo` "
+                "is correct."
+            ) from e
+        if len(paths) == 1:
+            return paths[0], True
+        else:
+            raise ValueError(f"{key} has multiple paths in the public API: {paths}")
+
+
+_kind_map = {
+    inspect.Parameter.POSITIONAL_ONLY: griffe.ParameterKind.positional_only,
+    inspect.Parameter.POSITIONAL_OR_KEYWORD: griffe.ParameterKind.positional_or_keyword,
+    inspect.Parameter.VAR_POSITIONAL: griffe.ParameterKind.var_positional,
+    inspect.Parameter.KEYWORD_ONLY: griffe.ParameterKind.keyword_only,
+    inspect.Parameter.VAR_KEYWORD: griffe.ParameterKind.var_keyword,
+}
+
+
+def _pretty_annotation(
+    annotation,
+    context: dict,
+    use_public_name: Callable[[None | dict, Any], None | wl.AbstractDoc],
+):
+    if annotation is inspect.Signature.empty:
+        return None
+    else:
+        return wl.pformat(
+            annotation, custom=ft.partial(use_public_name, context), width=9999
+        )
+
+
+def _pretty_param(
+    param: inspect.Parameter,
+    context: dict,
+    use_public_name: Callable[[None | dict, Any], None | wl.AbstractDoc],
+) -> griffe.Parameter:
+    annotation = _pretty_annotation(param.annotation, context, use_public_name)
+    if param.default is inspect.Signature.empty:
+        default = None
+    else:
+        default = wl.pformat(
+            param.default, custom=ft.partial(use_public_name, None), width=9999
+        )
+    return griffe.Parameter(
+        name=param.name,
+        annotation=annotation,
+        kind=_kind_map[param.kind],
+        default=default,
+    )
+
+
+def _pretty_fn(
+    obj: griffe.Function,
+    use_public_name: Callable[[None | dict, Any], None | wl.AbstractDoc],
+) -> None:
+    try:
+        module = sys.modules[obj.module.path]
+    except KeyError:
+        context = {}
+    else:
+        context = module.__dict__
+    signature: inspect.Signature = obj.extra["hippogriffe"]["signature"]
+    obj.parameters = griffe.Parameters(
+        *[
+            _pretty_param(param, context, use_public_name)
+            for param in signature.parameters.values()
+        ]
+    )
+    signature.return_annotation
+    obj.returns = _pretty_annotation(
+        signature.return_annotation, context, use_public_name
+    )
+
+
+_builtin_re = re.compile(r"builtins\.(\w+)")
+
+
+# Modified version of `griffe.Class.resolved_bases`, so as not to drop builtins.
+def _resolved_bases(cls: griffe.Class) -> list[str | griffe.Object]:
+    resolved_bases = []
+    for base in cls.bases:
+        base_path = base if isinstance(base, str) else base.canonical_path
+        match = _builtin_re.match(base_path)
+        with contextlib.suppress(
+            griffe.AliasResolutionError, griffe.CyclicAliasError, KeyError
+        ):
+            if match is None:
+                resolved_base = cls.modules_collection[base_path]
+                if resolved_base.is_alias:
+                    resolved_base = resolved_base.final_target
+            else:
+                resolved_base = match.group(1)
+                if not hasattr(builtins, resolved_base):
+                    raise KeyError
+            resolved_bases.append(resolved_base)
+    return resolved_bases
+
+
+def _collect_bases(
+    cls: griffe.Class, public_api: _PublicApi, public_modules: set[str]
+) -> dict[str, bool]:
+    bases: dict[str, bool] = {}
+    for base in _resolved_bases(cls):
+        if isinstance(base, str):
+            # builtins case above
+            if "builtins" in public_modules:
+                bases[base] = False
+        elif isinstance(base, griffe.Class):
+            try:
+                base, autoref = public_api[base.path]
+            except KeyError:
+                bases.update(_collect_bases(base, public_api, public_modules))
+            else:
+                bases[base] = autoref
+    return bases
+
+
+@ft.cache
+def _get_repo_url(repo_url: None | str) -> tuple[pathlib.Path, str]:
+    if repo_url is None:
+        raise ValueError(
+            "`hippogriffe.show_source_links` requires specifying a top-level "
+            "`repo_url`."
+        )
+    is_github = (
+        repo_url.removeprefix("https://")
+        .removeprefix("https://")
+        .startswith("github.com")
+    )
+    if not is_github:
+        # We need to format the `repo_url` to what the repo expects, so we have to
+        # hardcode this in.
+        raise ValueError(
+            "`hippogriffe.show_source_links` currently only supports "
+            "`repo_url: https://github.com/...`."
+        )
+    try:
+        git_head = subprocess.run(
+            ["git", "rev-parse", "HEAD"], capture_output=True, check=False
+        )
+        git_toplevel = subprocess.run(
+            ["git", "rev-parse", "--show-toplevel"], capture_output=True, check=False
+        )
+        if git_head.returncode != 0 or git_toplevel.returncode != 0:
+            raise FileNotFoundError
+    except FileNotFoundError as e:
+        raise ValueError(
+            "`hippogriffe.show_source_links` requires running from a git repository, "
+            "but could not find git commit hash or root."
+        ) from e
+    else:
+        toplevel = pathlib.Path(git_toplevel.stdout.decode().strip())
+        commit_hash = git_head.stdout.decode().strip()
+    repo_url = (
+        f"{repo_url.removesuffix('/')}/blob/{commit_hash}/{{path}}#L{{start}}-{{end}}"
+    )
+    return toplevel, repo_url
+
+
+class HippogriffeExtension(griffe.Extension):
+    def __init__(
+        self, config: PluginConfig, repo_url: None | str, top_level_public_api: set[str]
+    ):
+        self.config = config
+        self.repo_url = repo_url
+        self.top_level_public_api = top_level_public_api
+
+    def on_function_instance(
+        self,
+        *,
+        node: ast.AST | griffe.ObjectNode,
+        func: griffe.Function,
+        agent: griffe.Visitor | griffe.Inspector,
+        **kwargs: Any,
+    ) -> None:
+        del agent, kwargs
+        assert not isinstance(node, ast.AST)
+        func.extra["hippogriffe"]["signature"] = inspect.signature(node.obj)
+
+    def on_package_loaded(
+        self, *, pkg: griffe.Module, loader: griffe.GriffeLoader, **kwargs: Any
+    ) -> None:
+        assert self.top_level_public_api != {""}
+        del loader, kwargs
+
+        public_api = _PublicApi(
+            pkg,
+            top_level_public_api=self.top_level_public_api,
+            builtin_modules=self.config.builtin_modules,
+            stdlib_modules=self.config.stdlib_modules,
+            extra_public_modules=self.config.extra_public_modules,
+        )
+
+        def use_public_name(context: None | dict, obj: Any) -> None | wl.AbstractDoc:
+            # If we hit a Literal then don't try to convert any of its string-typed
+            # elements into types...
+            if get_origin(obj) is Literal:
+                return wl.pdoc(obj, width=9999)
+            # ...but otherwise do attempt to resolve strings into types.
+            if context is not None and isinstance(obj, str):
+                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):
+                new_path, _ = public_api[f"{obj.__module__}.{obj.__qualname__}"]
+                return wl.TextDoc(new_path)
+
+        public_modules = set(self.config.extra_public_modules) | set(
+            self.config.stdlib_modules
+        )
+        for obj in public_api:
+            if obj.is_function:
+                assert type(obj) is griffe.Function
+                obj.extra["mkdocstrings"]["template"] = "hippogriffe/fn.html.jinja"
+                _pretty_fn(obj, use_public_name)
+            elif obj.is_class:
+                assert type(obj) is griffe.Class
+                obj.extra["mkdocstrings"]["template"] = "hippogriffe/class.html.jinja"
+                if self.config.show_bases:
+                    public_bases = list(
+                        _collect_bases(obj, public_api, public_modules).items()
+                    )
+                    obj.extra["hippogriffe"]["public_bases"] = public_bases
+
+        if self.config.show_source_links == "none":
+            api_iterable = ()
+        elif self.config.show_source_links == "toplevel":
+            api_iterable = public_api.toplevel()
+        elif self.config.show_source_links == "all":
+            api_iterable = public_api
+        else:
+            assert False
+        for obj in api_iterable:
+            if (
+                obj.lineno is not None
+                and obj.endlineno is not None
+                and isinstance(obj.filepath, pathlib.Path)
+            ):
+                toplevel, repo_url = _get_repo_url(self.repo_url)
+                path = obj.filepath.relative_to(toplevel)
+                url = repo_url.format(path=path, start=obj.lineno, end=obj.endlineno)
+                obj.extra["hippogriffe"]["url"] = url

hippogriffe-0.1.0/hippogriffe/_plugin.py

@@ -0,0 +1,115 @@
+import pathlib
+import re
+import sys
+import typing
+
+from mkdocs.config import Config
+from mkdocs.config.config_options import Choice, Type
+from mkdocs.config.defaults import MkDocsConfig
+from mkdocs.plugins import BasePlugin, event_priority
+from mkdocs.structure.files import File, Files, InclusionLevel
+from mkdocstrings import AutoDocProcessor
+
+
+_here = pathlib.Path(__file__).resolve().parent
+
+
+class PluginConfig(Config):
+    show_bases = Type(bool, default=True)
+    """Whether to show class bases in-line with their name."""
+
+    show_source_links = Choice(["all", "toplevel", "none"], default="toplevel")
+    """Whether to include [source] links to the repo."""
+
+    extra_public_modules = Type(list, default=[])
+    """Any third-party modules whose objects are allowed in the public API."""
+
+    stdlib_modules = Type(list, default=list(sys.stdlib_module_names))
+    """A list of stdlib modules. This is concatenated with `extra_public_modules` to
+    form the list of external modules that are allowed in the public API
+    """
+
+    builtin_modules = Type(
+        list, default=["builtins", "collections.abc", "typing", "typing_extensions"]
+    )
+    """A list of 'builtin' module names we should strip from pretty type annotations.
+    For example `Sequence[Literal[1]]` instead of
+    `collections.abc.Sequence[typing_extensions.Literal[1]]`
+    """
+
+
+def _get_options(config: MkDocsConfig) -> dict:
+    mkdocstrings_config = config.plugins["mkdocstrings"].config
+    options = (
+        mkdocstrings_config.setdefault("handlers", {})
+        .setdefault("python", {})
+        .setdefault("options", {})
+    )
+    return options
+
+
+class HippogriffePlugin(BasePlugin[PluginConfig]):
+    css_filename: str = "assets/_hippogriffe.css"
+
+    @event_priority(50)  # Before mkdocstrings
+    def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
+        # Using the normalisation from https://peps.python.org/pep-0503/#normalized-names
+        # We extend it to also replace en dashes and em dashes.
+        # Not perfect but it should do.
+        typing.GENERATING_DOCUMENTATION = re.sub(  # pyright: ignore[reportAttributeAccessIssue]
+            r"[-_.–—]+", "-", config.site_name
+        ).lower()
+
+        options = _get_options(config)
+        if options.get("force_inspection", False) is not True:
+            raise ValueError(
+                "hippogriffe requires "
+                "`mkdocstrings.python.options.force_inspection: true`. (This is so it "
+                "can do things like display type annotations correctly.)"
+            )
+        extensions = options.setdefault("extensions", [])
+        extensions.append(
+            {
+                "hippogriffe._extension": {
+                    "config": self.config,
+                    "repo_url": config.repo_url,
+                    "top_level_public_api": {""},
+                }
+            }
+        )
+        # Lower priority than user files
+        config.extra_css.insert(0, self.css_filename)
+        if self.config.show_bases and options.get("merge_init_into_class", False):
+            raise ValueError(
+                "Cannot set both `hippogriffe.show_bases: true` and "
+                "`mkdocstrings.python.options.merge_init_into_class: true`, as they "
+                "use the same space in the documentation."
+            )
+
+    @event_priority(-50)  # After other plugins have generated files
+    def on_files(self, files: Files, /, *, config: MkDocsConfig) -> Files | None:
+        for extension in _get_options(config)["extensions"]:
+            if type(extension) is dict and set(extension.keys()) == {
+                "hippogriffe._extension"
+            }:
+                top_level_public_api = extension["hippogriffe._extension"][
+                    "top_level_public_api"
+                ]
+                assert top_level_public_api == {""}
+                break
+        else:
+            assert False
+        top_level_public_api.remove("")
+        for file in files:
+            if file.is_documentation_page():
+                for match in AutoDocProcessor.regex.finditer(file.content_string):
+                    top_level_public_api.add(match["name"])
+        files.append(
+            File.generated(
+                config=config,
+                src_uri=self.css_filename,
+                abs_src_path=str(_here / self.css_filename),
+                inclusion=InclusionLevel.INCLUDED,
+            )
+        )
+        return files

hippogriffe-0.1.0/hippogriffe/assets/_hippogriffe.css

@@ -0,0 +1,8 @@
+code.hippogriffe-repo-url {
+  background-color: rgba(0,0,0,0);
+}
+
+code.hippogriffe-repo-url::after {
+  font-size: 0.7rem;
+  content: "[source]";
+}

hippogriffe-0.1.0/hippogriffe/templates/material/hippogriffe/class.html.jinja

@@ -0,0 +1,22 @@
+{% extends "_base/class.html.jinja" %}
+{% import "hippogriffe/hippogriffe.jinja" as hippogriffe %}
+
+{% block heading %}
+  {#- Heading block.
+
+  This block renders the heading for the class.
+  -#}
+  {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
+  {% if config.separate_signature %}
+    <span class="doc doc-object-name doc-class-name">{{ config.heading if config.heading and root else class_name }}{{ hippogriffe.bases(class) }}</span>
+  {% elif config.merge_init_into_class and "__init__" in all_members %}
+    {% with function = all_members["__init__"] %}
+      {%+ filter highlight(language="python", inline=True) %}
+        {{ class_name }}{% include "signature"|get_template with context %}
+      {% endfilter %}
+    {% endwith %}
+  {% else %}
+    <code>{{ class_name }}{{ hippogriffe.bases(class) }}</code>
+  {% endif %}
+  {{ hippogriffe.url(class) }}
+{% endblock heading %}

hippogriffe-0.1.0/hippogriffe/templates/material/hippogriffe/fn.html.jinja

@@ -0,0 +1,7 @@
+{% extends "_base/function.html.jinja" %}
+{% import "hippogriffe/hippogriffe.jinja" as hippogriffe %}
+
+{% block heading %}
+  {{ super() }}
+  {{ hippogriffe.url(function) }}
+{% endblock heading %}

hippogriffe-0.1.0/hippogriffe/templates/material/hippogriffe/hippogriffe.jinja

@@ -0,0 +1,20 @@
+{%- macro bases(obj) -%}
+  {%- if obj.extra.hippogriffe.public_bases -%}
+    (
+    {%- for base, autoref in obj.extra.hippogriffe.public_bases -%}
+      {%- if autoref -%}
+        <autoref identifier="{{ base }}">{{ base }}</autoref>
+      {%- else -%}
+        {{ base }}
+      {%- endif -%}
+      {%- if not loop.last %}, {% endif -%}
+    {%- endfor -%}
+    )
+  {%- endif -%}
+{%- endmacro -%}
+
+{%- macro url(obj) -%}
+  {%- if obj.extra.hippogriffe.url -%}
+    <a href="{{ obj.extra.hippogriffe.url }}"><code class='hippogriffe-repo-url'></code></a>
+  {%- endif -%}
+{%- endmacro -%}

hippogriffe-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[project]
+authors = [
+  {email = "contact@kidger.site", name = "Patrick Kidger"}
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "License :: OSI Approved :: Apache Software License",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3"
+]
+dependencies = [
+  "griffe>=1.6.0",
+  "mkdocs>=1.6.1",
+  "mkdocstrings[python]>=0.28.3",
+  "wadler_lindig>=0.1.4"
+]
+description = "A simple ipynb->md converter for MkDocs"
+keywords = ["mkdocs", "mkdocstrings", "griffe", "md", "markdown"]
+license = {file = "LICENSE"}
+name = "hippogriffe"
+readme = "README.md"
+requires-python = ">=3.10"
+urls = {repository = "https://github.com/patrick-kidger/hippogriffe"}
+version = "0.1.0"
+
+[project.optional-dependencies]
+dev = ["pre-commit"]
+
+[project.entry-points."mkdocs.plugins"]
+hippogriffe = "hippogriffe._plugin:HippogriffePlugin"
+
+[project.entry-points."mkdocstrings.python.templates"]
+hippogriffe = "hippogriffe._extension:get_templates_path"
+
+[tool.hatch.build]
+include = ["hippogriffe/*"]
+
+[tool.pyright]
+include = ["hippogriffe"]
+
+[tool.ruff]
+extend-include = ["*.ipynb"]
+src = []
+
+[tool.ruff.lint]
+fixable = ["I001", "F401"]
+ignore = ["E402", "E721", "E731", "E741", "F722"]
+select = ["E", "F", "I001"]
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+lines-after-imports = 2
+order-by-type = true