griffe_inherited_method_crossrefs
Griffe extension to replace docstrings of inherited methods with cross-references to parent
For example, if a class foo.Child inherits the method do_something from bar.Parent, then in the generated documentation, the docstring of Child.do_something will appear similar to
Inherited from bar.Parent
whereas the docstring of bar.Parent.do_something will be unaffected.
Installation
pip install griffe-inherited-method-crossrefs
Usage
After installation, to use this extension with Mkdocs and mkdocstrings, add the following to your mkdocs.yml:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_inherited_method_crossrefs
Release files for griffe-inherited-method-crossrefs 0.0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| griffe_inherited_method_crossrefs-0.0.1.4.tar.gz | 7.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe_inherited_method_crossrefs-0.0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 19.1 kB
Release files / griffe_inherited_method_crossrefs-0.0.1.4.tar.gz
| Download URL | griffe_inherited_method_crossrefs-0.0.1.4.tar.gz |
|---|---|
| Size | 7.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cf488f11c1f569abffdebdaa865a01e71ef8e57dda045322b672b82db5421e80
|
|
BLAKE2b-256 checksum How to use checksums |
909374e2a445176bc71584e69458a0bdfb1dea9d3de0a6340839590f0956ba7f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.0
|
Release files / griffe_inherited_method_crossrefs-0.0.1.4-py3-none-any.whl
| Download URL | griffe_inherited_method_crossrefs-0.0.1.4-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
def4567780fb311922b8e3869c9305b957f04a633b0eed0f5959b66661556bf2
|
|
BLAKE2b-256 checksum How to use checksums |
109296a1761ad16eff2b91f8bc520bc7b66eb42e3e08410bcd7f86e484aa5a21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.0
|
