Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

autodoc: Updating the Developing autodoc extensions example #14098

Open
@LecrisUT

Description

@LecrisUT

Is your feature request related to a problem? Please describe.
Currently theDeveloping autodoc extensions is using the legacy interface. It is not clear how one is supposed to do the same with the new interface. Afaict, this is not yet a solved problem right now.

While we are at it, it would be nice to actually clarify:

  • What does extending autodoc do and what you can overwrite. The example seems to focus on adding to the contents, but what about other things that you would want to do like changing the signature?
  • How does it play withautomodule orsphinx-apidoc?
  • What are some usecases where you would want to do that? I can imagine it would be useful fordataclasses and equivalents likeattrs,pydantic, and those providing appropriate extensions to auto-document?
  • Can an object be autodocumented twice (maybe withno-index), once asautoclass in thesphinx-apidoc and once as your custom method somewhere else in your document? Are there pitfalls to be aware of when doing so?

Additional context

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp