CellSeg3d icon indicating copy to clipboard operation
CellSeg3d copied to clipboard

Using autosummary to generate full API docs

Open C-Achard opened this issue 1 year ago • 0 comments

Ideally, we would like to generate full API docs using autosummary in #50.

However, if one wants to include all members, attributes, etc, custom templates are needed, as per jupyter book documentation.

See example of custom template here.

A bug with sphinx-book-theme > 1.0.0 prevents one to use custom templates, however, as mentioned here : https://github.com/executablebooks/sphinx-book-theme/issues/729

Downgrading to sphinx-book-theme > 0.3.3 prevents this problem, but breaks other jupyter-book features.

Currently waiting for a fix from sphinx-book-theme, or another workaround.

C-Achard avatar Sep 28 '23 13:09 C-Achard