sphinx-doc/sphinx

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

Open

#2909 opened on Aug 26, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
help wantedtype:docs

Description

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.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
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.