================
.. toctree:: +
================
.. start short_desc
**Enhanced Sphinx TocTree which shows classes, functions etc. as if they were sections.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/toctree-plus/latest?logo=read-the-docs
:target: https://toctree-plus.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/toctree_plus/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/toctree_plus/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/toctree_plus/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/toctree_plus?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/toctree_plus?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/toctree_plus
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/toctree_plus
:target: https://pypi.org/project/toctree_plus/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/toctree_plus?logo=python&logoColor=white
:target: https://pypi.org/project/toctree_plus/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/toctree_plus
:target: https://pypi.org/project/toctree_plus/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/toctree_plus
:target: https://pypi.org/project/toctree_plus/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/toctree_plus?logo=anaconda
:target: https://anaconda.org/domdfcoding/toctree_plus
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/toctree_plus?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/toctree_plus
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/toctree_plus
:target: https://github.com/sphinx-toolbox/toctree_plus/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/toctree_plus
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/toctree_plus/v0.7.0
:target: https://github.com/sphinx-toolbox/toctree_plus/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/toctree_plus
:target: https://github.com/sphinx-toolbox/toctree_plus/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2024
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/toctree_plus
:target: https://pypi.org/project/toctree_plus/
:alt: PyPI - Downloads
.. end shields
This idea has been suggested in `sphinx-doc/sphinx#6316`_ and `sphinx-doc/sphinx#6435`_
You can see ``toctree-plus`` in action in `this project's documentation`_,
and the documentation for domdf-python-tools_ (ReadTheDocs Sphinx Theme) and whey_ (Furo Sphinx Theme).
.. _sphinx-doc/sphinx#6316: https://github.com/sphinx-doc/sphinx/issues/6316
.. _sphinx-doc/sphinx#6435: https://github.com/sphinx-doc/sphinx/issues/6435
.. _this project's documentation: https://toctree-plus.readthedocs.io/en/latest/docs.html
.. _domdf-python-tools: https://domdf-python-tools.readthedocs.io/en/latest/api/iterative.html
.. _whey: https://whey.readthedocs.io/en/latest/api/config.html
Installation
--------------
.. start installation
``toctree_plus`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install toctree_plus
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install toctree_plus
.. end installation
Enable ``toctree_plus`` by adding ``"sphinxcontrib.toctree_plus"`` to the ``extensions`` variable in ``conf.py``:
.. code-block:: python
extensions = [
...
"sphinxcontrib.toctree_plus",
]
For more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .
Configuration
^^^^^^^^^^^^^^^^
There is currently only a single configuration option: ``toctree_plus_types``.
This determines the directive types that appear in the toctree. The default value is ``{"class", "function", "method"}``.
Links
-----
- Source: https://github.com/sphinx-toolbox/toctree_plus
- Bugs: https://github.com/sphinx-toolbox/toctree_plus/issues
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/toctree_plus",
"name": "toctree-plus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "documentation, sphinx, sphinx-extension",
"author": null,
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/6b/23/0cd95b34cf5a2f673c9f9c35d2908ad3886dbba088657b076ac63cc3cf92/toctree_plus-0.7.0.tar.gz",
"platform": "Windows",
"description": "\n================\n.. toctree:: +\n================\n\n.. start short_desc\n\n**Enhanced Sphinx TocTree which shows classes, functions etc. as if they were sections.**\n\n.. end short_desc\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/toctree-plus/latest?logo=read-the-docs\n\t:target: https://toctree-plus.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/toctree_plus/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/toctree_plus/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/toctree_plus/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/toctree_plus/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/toctree_plus?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/toctree_plus?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/toctree_plus\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/toctree_plus\n\t:target: https://pypi.org/project/toctree_plus/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/toctree_plus?logo=python&logoColor=white\n\t:target: https://pypi.org/project/toctree_plus/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/toctree_plus\n\t:target: https://pypi.org/project/toctree_plus/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/toctree_plus\n\t:target: https://pypi.org/project/toctree_plus/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/toctree_plus?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/toctree_plus\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/toctree_plus?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/toctree_plus\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/toctree_plus\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/toctree_plus\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/toctree_plus/v0.7.0\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/toctree_plus\n\t:target: https://github.com/sphinx-toolbox/toctree_plus/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2024\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/toctree_plus\n\t:target: https://pypi.org/project/toctree_plus/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\nThis idea has been suggested in `sphinx-doc/sphinx#6316`_ and `sphinx-doc/sphinx#6435`_\n\nYou can see ``toctree-plus`` in action in `this project's documentation`_,\nand the documentation for domdf-python-tools_ (ReadTheDocs Sphinx Theme) and whey_ (Furo Sphinx Theme).\n\n.. _sphinx-doc/sphinx#6316: https://github.com/sphinx-doc/sphinx/issues/6316\n.. _sphinx-doc/sphinx#6435: https://github.com/sphinx-doc/sphinx/issues/6435\n.. _this project's documentation: https://toctree-plus.readthedocs.io/en/latest/docs.html\n.. _domdf-python-tools: https://domdf-python-tools.readthedocs.io/en/latest/api/iterative.html\n.. _whey: https://whey.readthedocs.io/en/latest/api/config.html\n\nInstallation\n--------------\n\n.. start installation\n\n``toctree_plus`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install toctree_plus\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install toctree_plus\n\n.. end installation\n\nEnable ``toctree_plus`` by adding ``\"sphinxcontrib.toctree_plus\"`` to the ``extensions`` variable in ``conf.py``:\n\n.. code-block:: python\n\n\textensions = [\n\t\t...\n\t\t\"sphinxcontrib.toctree_plus\",\n\t\t]\n\nFor more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .\n\nConfiguration\n^^^^^^^^^^^^^^^^\n\nThere is currently only a single configuration option: ``toctree_plus_types``.\nThis determines the directive types that appear in the toctree. The default value is ``{\"class\", \"function\", \"method\"}``.\n\nLinks\n-----\n\n- Source: https://github.com/sphinx-toolbox/toctree_plus\n- Bugs: https://github.com/sphinx-toolbox/toctree_plus/issues\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Enhanced Sphinx TocTree which shows classes, functions etc. as if they were sections.",
"version": "0.7.0",
"project_urls": {
"Documentation": "https://toctree-plus.readthedocs.io/en/latest",
"Homepage": "https://github.com/sphinx-toolbox/toctree_plus",
"Issue Tracker": "https://github.com/sphinx-toolbox/toctree_plus/issues",
"Source Code": "https://github.com/sphinx-toolbox/toctree_plus"
},
"split_keywords": [
"documentation",
" sphinx",
" sphinx-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4de35c5d276e8cee11ce825924eaebe6e4f25cf9fc356f3743ba10e015045622",
"md5": "0e9c2084dd6262f58133490a97f0d29f",
"sha256": "d6536b180e9beff350c2613cdc19a610c525e9fe77a185174b6b11f0e5d9740e"
},
"downloads": -1,
"filename": "toctree_plus-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e9c2084dd6262f58133490a97f0d29f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7873,
"upload_time": "2024-06-25T10:36:29",
"upload_time_iso_8601": "2024-06-25T10:36:29.208135Z",
"url": "https://files.pythonhosted.org/packages/4d/e3/5c5d276e8cee11ce825924eaebe6e4f25cf9fc356f3743ba10e015045622/toctree_plus-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b230cd95b34cf5a2f673c9f9c35d2908ad3886dbba088657b076ac63cc3cf92",
"md5": "7cd54a3e1f11defb0fbdb6ee96d1b4f9",
"sha256": "2a6250658a35b6d72efe12f59cb42d1cc27f6b4460fbfcd407fbbdcd44f43a01"
},
"downloads": -1,
"filename": "toctree_plus-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "7cd54a3e1f11defb0fbdb6ee96d1b4f9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7554,
"upload_time": "2024-06-25T10:36:30",
"upload_time_iso_8601": "2024-06-25T10:36:30.996087Z",
"url": "https://files.pythonhosted.org/packages/6b/23/0cd95b34cf5a2f673c9f9c35d2908ad3886dbba088657b076ac63cc3cf92/toctree_plus-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 10:36:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-toolbox",
"github_project": "toctree_plus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "toctree-plus"
}
JSON
