pytkdocs_tweaks
Some custom tweaks for pytkdocs.
For use as part of the documentation-generation-for-Python stack that comprises mkdocs, mkdocs-material, mkdocstrings and pytkdocs.
- Types are ubiquitously displayed in the way you import them:
package.Foo(rather than being a mix of where they're defined:package.subpackage.foomodule.Fooor just their name:Foo). - Only public base classes are shown (rather than every base class).
- Adds short documentation for inherited and implemented methods, e.g. "Inherited from
package.Foo." (Rather than nothing at all.)- An inherited method is one inherited from a base class. An implemented method is one overriding an abstract method on a base class.
- Sets a custom
typing.GENERATING_DOCUMENTATION = Trueflag that you can use to detect when documentation generation is happening and customise things if desired (documentation generation imports the library you're documenting). - Adds an
abstractmethod/abstractpropertyproperty to appear in the documentation instead. (Useful when specifying abstract base classes.) - Removed the
dataclassandspecialproperties that appear in the documentation. (I find that these just add visual noise.) - Removed the
-> Nonereturn annotation on__init__methods. - Function-valued defaults now display as just
<function foo>rather than<function foo at 0x7f5428d27a60>.
Note that you must run the mkdocs command twice, as these custom tweaks write a cache to disk -- listing all the public objects -- that are then used on the second run. If you see a .all_objects.cache file appear -- this is why. (You may wish to add the file to your .gitignore.)
Installation
pip install pytkdocs_tweaks
Requires Python 3.8+ and pytkdocs==0.15.0.
Usage
In your mkdocs.yml:
plugins:
- search # default plugin, need to re-enable when using manual plugins
- mkdocstrings:
handlers:
python:
setup_commands:
- import pytkdocs_tweaks
- pytkdocs_tweaks.main()
selection:
inherited_members: true # allow looking up inherited members
rendering:
show_root_heading: true #
show_root_full_path: true # have e.g. `package.Foo` display correctly, rather than e.g. just `Foo`.
Metadata
Release files for pytkdocs-tweaks 0.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pytkdocs_tweaks-0.0.8.tar.gz | 10.2 kB | Without provenance | Details for pytkdocs_tweaks-0.0.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytkdocs_tweaks-0.0.8-py3-none-any.whl | Python 3 | none | any | Details for pytkdocs_tweaks-0.0.8-py3-none-any.whl |
Total release size: 23.9 kB
Release files / pytkdocs_tweaks-0.0.8.tar.gz
| Download URL | pytkdocs_tweaks-0.0.8.tar.gz |
|---|---|
| Size | 10.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
74bb2cfa77432a322156e128fe07b8e1c3207e6376afc0b3c4f5dd61ed65f206
|
|
BLAKE2b-256 checksum How to use checksums |
8ed3e8ea03e43e8545f37d4b0e7362783604ad953572a931284688836a6edbd6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Release files / pytkdocs_tweaks-0.0.8-py3-none-any.whl
| Download URL | pytkdocs_tweaks-0.0.8-py3-none-any.whl |
|---|---|
| Size | 13.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
facc4b8accc93670dec70cdf42d5a576e47f78b40fd168466e608cf84689dca5
|
|
BLAKE2b-256 checksum How to use checksums |
8bc4916cce0b1e99d7602d95419a97561115f6ac0c4dc401366002fdc517290a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.7
|
Security for pytkdocs-tweaks 0.0.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.