Skip to main content

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 the extensions-list should not contain "sphinx.ext.autosummary" but "sphinx_autosummary_autocollect"
  • in the .. autosummary:: you can provide no symbols. In that case sphinx_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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autosummary_autocollect-0.1.1.tar.gz (21.0 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page