sphinx-doc/sphinx

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

Open

#2,909 opened on 2016年8月26日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.