sphinx-autosummary-autocollect
Sphinx plugin based on autosummary, that automatically collects symbols if non are provided.
Installation
Install the latest built version via:
pip install sphinx-autosummary-autocollect
To develop on this project, clone it via:
git clone git@github.com:helpmefindaname/sphinx_autosummary_autocollect.git
cd sphinx_autosummary_autocollect
Then use poetry to install the project:
poetry install
Usage
Note
This plugin was only tested with sphinx 7.4.7. If you are using a newer version and the plugin stops working, please create an issue
This plugin is based on AutoSummary and should be used the same way. There are only 2 differences:
- in the
conf.pytheextensions-list should not contain"sphinx.ext.autosummary"but"sphinx_autosummary_autocollect" - in the
.. autosummary::you can provide no symbols. In that casesphinx_autosummary_autocollectwill build a table and subpages for all elements that can be extracted from the "current-module"
for example, instead of specifying:
my_module
=========
.. currentmodule:: my_module
.. autosummary::
:toctree: generated
:nosignatures:
class1
function1
you can now leave the elements out:
my_module
=========
.. currentmodule:: my_module
.. autosummary::
:toctree: generated
:nosignatures:
Note
This is a note
Metadata
Release files for sphinx-autosummary-autocollect 0.1.1
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 |
|---|---|---|---|---|
| sphinx_autosummary_autocollect-0.1.1.tar.gz | 21.0 kB | Without provenance | Details for sphinx_autosummary_autocollect-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl |
Total release size: 43.3 kB
Release files / sphinx_autosummary_autocollect-0.1.1.tar.gz
| Download URL | sphinx_autosummary_autocollect-0.1.1.tar.gz |
|---|---|
| Size | 21.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6af1d2c9541693465a3cf67cab4719177201c51b94a30b79f72f5d5c29f93b12
|
|
BLAKE2b-256 checksum How to use checksums |
d936216c4ed4189c4053794b7cb6277788e3dc1d679a76927d69f73152519648
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure
|
Release files / sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl
| Download URL | sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2ba7155296583226325f15ceb5a875eee889222a1e2d2054f025f6687c0de410
|
|
BLAKE2b-256 checksum How to use checksums |
e92483297d94c7ed49ff12ea975c2af1b25e2e789db327d2bb0fe522de4d2769
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure
|
Security for sphinx-autosummary-autocollect 0.1.1
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.