sphinx-doc / sphinx-doc/sphinx

https://www.sphinx-doc.org/en/master/usage/quickstart.html is unclear

Open
#8,199 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type:bug type:docs
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

This page is unclear on a number of items; the following is a partial list:

(1) "Sphinx focuses on documentation, in particular handwritten documentation": I suspect that what's meant here is "human-generated documentation" rather than "handwritten documentation". Sphinx doesn't do optical character recognition on handwriting.

(2) "The toctree directive initially is empty, and looks like so:": This comment is followed by a bunch of not terribly illuminating blank space.

(3) What do the two dots in front of the toctree signify? Is any directive supposed to be preceded by two dots?

(4) It is good to know that directives are versatlile, but what is the general purpose of directives? This is never explained.

(5) Is a toctree directive the only way to get an entry added to the table of contents?

(6) "A common gotcha with directives is that the first line of the content must be indented to the same level as the options are." What about subsequent lines?

(7) Do directives have scope, or is that concept inapplicable?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the quickstart page at https://www.sphinx-doc.org/en/master/usage/quickstart.html and review each of the seven listed points in context. Done means revising the page so the terminology, toctree syntax, directive purpose and scope, indentation guidance, and table-of-contents behavior are clearly explained.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.