sphinx-doc / sphinx-doc/sphinx
Sphinx toctree numbering not shown on external link entries
Open
Nobody has claimed this yet.
internals:toctree
type:bug
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Problem
toctree entries which refer to an external link are not assigned a number when using :numbered:.
Procedure to reproduce the problem
../index.rst
.. toctree::
:numbered:
Administration <admin/admin.rst>
Usage <usage/usage.rst>
Sphinx <https://github.com/sphinx-doc>
Introduction
============
...
Output
Expected behaviour
Environment info
- OS: Ubuntu 18.04.2
- Python version: 3.6.7
- Sphinx (sphinx-build): 1.6.7
- Extra tools: sphinx_rtd_theme
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the issue with the ../index.rst toctree using :numbered: and the external Sphinx link, then trace how Sphinx assigns numbers to toctree entries. Done means external-link entries receive numbering consistent with the expected result while existing document links continue to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100