sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3,898 opened on Jun 29, 2017

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
apidomainhelp wantedtype:proposal

Description

The current Sphinx api regarding extending domains is very confusing: why is there add_role_to_domain(), and add_directive_to_domain() but no add_object_type_to_domain() ? So if someone wants to add new object types to existing domain, the proper way now is to override the whole domain and add new types in the new class. It's also confusing because developer may mix inheritance-based customization and app-method-based customization. Having to use one, or another, but not both could improve the clarity.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Python knowledgeUnderstanding of Sphinx domains API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Investigate the implementation of `add role to domain()` and `add directive to domain()` in the Sphinx source code, likely in `sphinx/domains/ init .py` or similar. Determine the pattern and implement `add object type to domain()` following the same conventions. Check if there are any comments from maintainers about the feature to ensure alignment with project direction.