Skip to content

Using autosummary to generate full API docs #51

@C-Achard

Description

@C-Achard

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 :
executablebooks/sphinx-book-theme#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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions