sphinx-doc/sphinx

documentation: please link "doctree" to the doctree API documentation (or source code if none is found)

Open

#2,909 创建于 2016年8月26日

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

描述

The Sphinx Application API does a good job of covering various methods.

In the "core events" section, there are, however, several references to doctree from docutils, and it is maddeningly difficult to figure out what can be done with this object, since I have no experience with docutils and can't find any documentation about the Python API, just the XML structure here http://docutils.sourceforge.net/docs/ref/doctree.html

Please link doctree to an appropriate page in docutils.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
The issue requests adding a hyperlink for the term 'doctree' in Sphinx's documentation to the appropriate docutils API documentation. Look for the source file documenting the Application API, likely in the Sphinx repo under docs/ or sphinx/ext/. Find where 'doctree' is mentioned without a link in the core events section. Then locate the docutils documentation or source code for the doctree object and add a cross reference. No existing PRs or comments provide further guidance.