sphinx-doc/sphinx

Consider adding add_object_type_to_domain() method

Open

#3,898 创建于 2017年6月29日

在 GitHub 查看
 (2 评论) (1 反应) (0 负责人)Python (5,625 star) (1,985 fork)batch import
apidomainhelp wantedtype:proposal

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic Python knowledgeUnderstanding of Sphinx domains API
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
65
研究方向
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.