# sphinx-autosummary-autocollect
Sphinx plugin based on autosummary, that automatically collects symbols if non are provided.
## Installation
Install the latest built version via:
````commandline
pip install sphinx-autosummary-autocollect
````
To develop on this project, clone it via:
```commandline
git clone git@github.com:helpmefindaname/sphinx_autosummary_autocollect.git
cd sphinx_autosummary_autocollect
```
Then use [poetry](https://python-poetry.org/docs/#installation) 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](https://github.com/helpmefindaname/sphinx_autosummary_autocollect/issues)
This plugin is based on [AutoSummary](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) 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:
````rst
my_module
=========
.. currentmodule:: my_module
.. autosummary::
:toctree: generated
:nosignatures:
class1
function1
````
you can now leave the elements out:
````rst
my_module
=========
.. currentmodule:: my_module
.. autosummary::
:toctree: generated
:nosignatures:
````
> **Note**
>
> This is a note
Raw data
{
"_id": null,
"home_page": "https://github.com/helpmefindaname/python-template",
"name": "sphinx-autosummary-autocollect",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Benedikt Fuchs",
"author_email": "benedikt.fuchs.staw@hotmail.com",
"download_url": "https://files.pythonhosted.org/packages/d9/36/216c4ed4189c4053794b7cb6277788e3dc1d679a76927d69f73152519648/sphinx_autosummary_autocollect-0.1.1.tar.gz",
"platform": null,
"description": "# sphinx-autosummary-autocollect\n\nSphinx plugin based on autosummary, that automatically collects symbols if non are provided. \n\n## Installation\n\nInstall the latest built version via:\n````commandline\npip install sphinx-autosummary-autocollect\n````\n\nTo develop on this project, clone it via:\n```commandline\ngit clone git@github.com:helpmefindaname/sphinx_autosummary_autocollect.git\ncd sphinx_autosummary_autocollect\n```\nThen use [poetry](https://python-poetry.org/docs/#installation) to install the project: \n```\npoetry install\n```\n\n## Usage\n\n> **Note**\n>\n> This plugin was only tested with sphinx 7.4.7.\n> If you are using a newer version and the plugin stops working, please create an [issue](https://github.com/helpmefindaname/sphinx_autosummary_autocollect/issues)\n\nThis plugin is based on [AutoSummary](https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) and should be used the same way.\nThere are only 2 differences:\n* in the `conf.py` the `extensions`-list should not contain `\"sphinx.ext.autosummary\"` but `\"sphinx_autosummary_autocollect\"`\n* 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\"\n\nfor example, instead of specifying:\n````rst\nmy_module\n=========\n\n.. currentmodule:: my_module\n\n.. autosummary::\n :toctree: generated\n :nosignatures:\n \n class1\n function1\n````\nyou can now leave the elements out:\n````rst\nmy_module\n=========\n\n.. currentmodule:: my_module\n\n.. autosummary::\n :toctree: generated\n :nosignatures:\n````\n\n> **Note**\n>\n> This is a note",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "Sphinx plugin based on autosummary, that automatically collects symbols if non are provided .",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/helpmefindaname/python-template",
"Repository": "https://github.com/helpmefindaname/python-template"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e92483297d94c7ed49ff12ea975c2af1b25e2e789db327d2bb0fe522de4d2769",
"md5": "9e797d548a7c9a094ad58e149a68a882",
"sha256": "2ba7155296583226325f15ceb5a875eee889222a1e2d2054f025f6687c0de410"
},
"downloads": -1,
"filename": "sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9e797d548a7c9a094ad58e149a68a882",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 22332,
"upload_time": "2024-09-28T18:03:57",
"upload_time_iso_8601": "2024-09-28T18:03:57.185879Z",
"url": "https://files.pythonhosted.org/packages/e9/24/83297d94c7ed49ff12ea975c2af1b25e2e789db327d2bb0fe522de4d2769/sphinx_autosummary_autocollect-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d936216c4ed4189c4053794b7cb6277788e3dc1d679a76927d69f73152519648",
"md5": "4cefaa1d707db378af3b5ae5d359d5df",
"sha256": "6af1d2c9541693465a3cf67cab4719177201c51b94a30b79f72f5d5c29f93b12"
},
"downloads": -1,
"filename": "sphinx_autosummary_autocollect-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4cefaa1d707db378af3b5ae5d359d5df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 20961,
"upload_time": "2024-09-28T18:03:58",
"upload_time_iso_8601": "2024-09-28T18:03:58.518059Z",
"url": "https://files.pythonhosted.org/packages/d9/36/216c4ed4189c4053794b7cb6277788e3dc1d679a76927d69f73152519648/sphinx_autosummary_autocollect-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-28 18:03:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "helpmefindaname",
"github_project": "python-template",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-autosummary-autocollect"
}
JSON
