griffe-autodocstringstyle
Set docstring style to 'auto' for external packages.
Installation
pip install griffe-autodocstringstyle
Usage
Enable the griffe_autodocstringstyle extension. Now all packages loaded from a virtual environment will have their docstrings parsed with the auto style (automatically guessing the docstring style).
Use the exclude option to pass package names that shouldn't be considered. This can be useful if you must first install your sources as a package before loading/documenting them (meaning they end up in the virtual environment too).
With MkDocs:
plugins:
- mkdocstrings:
handlers:
python:
options:
extensions:
- griffe_autodocstringstyle:
# only useful if your sources can't be found
# in the current working directory
exclude:
- my_package
Sponsors
Silver sponsors
Bronze sponsors
And 4 more private sponsor(s).
1 maintainer
Metadata
1 maintainer
Release files for griffe-autodocstringstyle 0.2.2
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_autodocstringstyle-0.2.2.tar.gz | 30.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| griffe_autodocstringstyle-0.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.5 kB
Release files / griffe_autodocstringstyle-0.2.2.tar.gz
| Download URL | griffe_autodocstringstyle-0.2.2.tar.gz |
|---|---|
| Size | 30.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
feca5d82a1880fbe41aeba4ae6a8df3b5c416c6003151554b126c2cf641c24ed
|
|
BLAKE2b-256 checksum How to use checksums |
5db5a4f64d5b109fd532f7a11daedfce333fee1485e8f5e0070ec5315c2afb02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / griffe_autodocstringstyle-0.2.2-py3-none-any.whl
| Download URL | griffe_autodocstringstyle-0.2.2-py3-none-any.whl |
|---|---|
| Size | 9.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c1bc72fb7bf519bf8e22ef0f8f35a60b3963296d23388790e639edd883c46b17
|
|
BLAKE2b-256 checksum How to use checksums |
23534381b4967e533bf2f8f68691c5157524eff56cfb8de66ac4a5d2e5f4886f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
