Sphinx plugin based on autosummary, that automatically collects symbols if non are provided .
Project description
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.py
theextensions
-list should not contain"sphinx.ext.autosummary"
but"sphinx_autosummary_autocollect"
- in the
.. autosummary::
you can provide no symbols. In that casesphinx_autosummary_autocollect
will 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinx_autosummary_autocollect-0.1.1.tar.gz
.
File metadata
- Download URL: sphinx_autosummary_autocollect-0.1.1.tar.gz
- Upload date:
- Size: 21.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6af1d2c9541693465a3cf67cab4719177201c51b94a30b79f72f5d5c29f93b12 |
|
MD5 | 4cefaa1d707db378af3b5ae5d359d5df |
|
BLAKE2b-256 | d936216c4ed4189c4053794b7cb6277788e3dc1d679a76927d69f73152519648 |
File details
Details for the file sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl
- Upload date:
- Size: 22.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.8.0-1014-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ba7155296583226325f15ceb5a875eee889222a1e2d2054f025f6687c0de410 |
|
MD5 | 9e797d548a7c9a094ad58e149a68a882 |
|
BLAKE2b-256 | e92483297d94c7ed49ff12ea975c2af1b25e2e789db327d2bb0fe522de4d2769 |