Basic Usage

Installation

To install the package, run the following command:

pip install sphinx-autodoc-toolbox

This will install the package and its dependencies.

Extensions

Collapsible members

To use the collapsible members for autoclass, add the following to your Sphinx configuration file:

extensions = [
    'sphinx_autodoc_toolbox.collapse',
]

Then, in your documentation, use the autodoc directives to generate the docs just as you would normally. below if an example incorporating with the autoclasstoc extension:

class example.Example

This is an example class

Public Data Attributes:

attribute

This is a public attribute

Public Methods:

__init__()	This is the constructor of the Example class
public_method()	This is a public method

Private Methods:

_private_method()

This is a private method

---

Member Details:

__init__()

This is the constructor of the Example class

__weakref__

list of weak references to the object (if defined)

_private_method()

This is a private method

attribute = 1

This is a public attribute

public_method()

This is a public method