Sorting/factoring out inherited members

Open
#2,829 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reading the linked Sphinx users discussion and the autodoc_member_order behavior named in this issue. Investigate how inherited members are currently documented; done would require a decided design and implementation for separating inherited members and optionally factoring shared ancestor APIs into one linked copy.

Written by the indexing model from the issue text.

Description

extensions:autodoc type:proposal

I am having an issue similar to the one reported here: https://groups.google.com/forum/#!topic/sphinx-users/PTbNmTinLpk

Basically it would be nice if it was possible to separate out inherited members independently of the autodoc_member_order option (pydoc even splits the inherited member based on which is the class they were actually defined in). When multiple classes that end up being documented in the same page share some ancestors, it may also be worth factoring that ancestor's API to a single copy (linked to by the subclasses) rather than having one copy per subclass.

Dominant language
Python
Stars
8k
Forks
2.6k
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sphinx-doc/sphinx

All issues in sphinx-doc/sphinx

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.