我最终需要以下文件:
modules.rst:
API Reference=============.. rubric:: Modules.. autosummary:: :toctree: generated sparse
_templates/autosummary/module.rst:
{{ fullname | escape | underline }}.. rubric:: Description.. automodule:: {{ fullname }}.. currentmodule:: {{ fullname }}{% if classes %}.. rubric:: Classes.. autosummary:: :toctree: . {% for class in classes %} {{ class }} {% endfor %}{% endif %}{% if functions %}.. rubric:: Functions.. autosummary:: :toctree: . {% for function in functions %} {{ function }} {% endfor %}{% endif %}_templates/autosummary/class.rst:
{{ fullname | escape | underline}}.. currentmodule:: {{ module }}.. autoclass:: {{ objname }} {% block methods %} {% block attributes %} {% if attributes %} .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: {% for item in all_attributes %} {%- if not item.startswith('_') %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %} {% endif %} {% endblock %} {% if methods %} .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages. .. autosummary:: :toctree: {% for item in all_methods %} {%- if not item.startswith('_') or item in ['__call__'] %} {{ name }}.{{ item }} {%- endif -%} {%- endfor %} {% endif %} {% endblock %}_templates/autosummary/base.rst:
{{ fullname | escape | underline}}.. currentmodule:: {{ module }}.. auto{{ objtype }}:: {{ objname }}我还需要转到
sphinx/ext/autosummary/generate.py并设置
imported_members=True功能
generate_autosummary_docs。
如果您
numpydoc不像我一样使用,则可能需要删除
.. HACK指令。



