Opened 22 months ago

Last modified 5 weeks ago

#28290 assigned Cleanup/optimization

Doc sections are missing target (labels) links

Reported by: Tony Narlock Owned by: Kamalesh Palanisamy
Component: Documentation Version: 1.11
Severity: Normal Keywords: docs labels intersphinx
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no


Experiencing this while writing an article about Django. Some sections are missing intersphinx references.

This has actually been plaguing me for a few years when trying to link up Django's excellent docs via sphinx. Probably 85% of intersphinx links to Django work perfectly, but there are some outliers.

With sphinx installed (pip install --user sphinx), this command can be used to print intersphinx reference names to stdout (for double checking).

python -m sphinx.ext.intersphinx ''

Supposedly, docutils/sphinx is supposed to automatically assign target links:

Labels that aren’t placed before a section title can still be referenced to, but you must give the link an explicit title, using this syntax: :ref:Link title <label-name>.


For reference, I also opened a possibly related Sphinx-doc ticket about that:

Here are a few cases of missing sections that need manual labels:

Using Sessions in views (git, docs)

Shell (git docs)

Change History (6)

comment:1 Changed 22 months ago by Tony Narlock

Owner: changed from nobody to Tony Narlock
Status: newassigned

Here is another one I can't get a header for.

To add, using sphinx 1.6.3, python 3.6.1, macOS siera.

Version 0, edited 22 months ago by Tony Narlock (next)

comment:2 Changed 22 months ago by Tim Graham

Triage Stage: UnreviewedAccepted

comment:5 Changed 2 months ago by Carlton Gibson

Owner: Tony Narlock deleted
Status: assignednew

Hi Tony, I'm going to deassign this. It's been 20months without a patch, and as an Easy Pickings ticket it's likely to get picked up quickly if not claimed. Please do reclaim if you do in fact have a patch. Thanks for the report!

comment:6 Changed 5 weeks ago by Kamalesh Palanisamy

Owner: set to Kamalesh Palanisamy
Status: newassigned
Note: See TracTickets for help on using tickets.
Back to Top