{"categories":[{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"Generates a structured table of contents for auto-documented Python classes in Sphinx, organizing class members into meaningful sections while collapsing inherited methods to improve navigation.","skillfed_tags":["sphinx-extension","api-docs"],"use_cases":["Documenting large classes with many methods where a flat list is hard to navigate.","Organizing class methods by category (public, private, special, inherited) in auto-generated docs.","Collapsing inherited methods to highlight a class's own functionality while keeping full documentation.","Integrating custom section logic into Sphinx autodoc workflows without manual TOC maintenance.","Improving user experience in API documentation for complex Python libraries."],"what_it_does":"autoclasstoc is a Sphinx extension that adds a custom reStructuredText directive to generate a table of contents for Python classes. It solves the navigation problem that arises when using Sphinx's autodoc plugin: while autodoc fully documents every class member, it presents them sequentially without a summary, making it hard for users to understand what a class does or find specific methods. autoclasstoc inserts a collapsible TOC that groups methods into user-defined sections (e.g., public/private, by decorator, by prefix) and collapses inherited methods, so the documentation remains complete while staying navigable.\n\nThe package depends on Sphinx, docutils, and more_itertools. It is designed to integrate seamlessly with existing autodoc and autogen workflows. Maintenance is dormant and the license is undeclared, creating uncertainty about both long-term support and legal terms.","worth_installing":"Yes, if you are using Sphinx to document complex Python classes and want better navigation without manual TOC maintenance. The low install friction and lack of security vulnerabilities make it safe to try. However, the unclear license and dormant maintenance mean you should verify license compatibility upfront and be prepared to maintain a fork if critical bugs emerge. Not recommended for projects with strict license compliance requirements."},"id":"autoclasstoc","links":{"html":"https://skillfed.io/packages/autoclasstoc","md":"https://skillfed.io/packages/autoclasstoc.md","pypi":"https://pypi.org/project/autoclasstoc/"},"maintenance":{"status":"dormant"},"meta":{"latest_release":"2024-10-15","license_spdx":null,"license_treatment":"unclear","name":"autoclasstoc","python_support":"supports_current","summary":"Add a succinct TOC to auto-documented classes."},"popularity":{"monthly_downloads":182386,"position":10100,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.7.0"}