astropy / astropy/sphinx-automodapi

Inheritance diagram top classes

Open
#244 0 comments 0 reactions 0 assignees View on GitHub
question
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html#directive-inheritance-diagram says it is possible to use `top-classes` to shorten the diagram. Is there a way to use that when I use `automodapi` for the module and the inheritance diagram is automatically generated?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Sphinx inheritance-diagram directive documentation and the automodapi-generated inheritance diagram entry point. Determine whether `top-classes` can be passed through automatic generation; done means documenting the supported configuration or identifying the missing feature and its expected behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.