ipython / ipython/traitlets

autodoc plugin for sphinx

Open
#210 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
653
Forks
217
Avg merge
2d 21h
Merged PRs (30d)
2

Description

Perhaps related to #131, we should consider an extension to sphinx autodoc that would let you include trait info, such as types and help strings, in autodoc output.

This doesn't have to start in this repo, it can be a standalone extension, but I think it would be useful for things like generating good docs on what's configurable in a project.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.