#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
Reporter: Tony | Owner: nobody
Narlock |
Type: | Status: new
Cleanup/optimization |
Component: | Version: 1.11
Documentation | Keywords: docs labels
Severity: Normal | intersphinx
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
-------------------------------------+-------------------------------------
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
'http://docs.djangoproject.com/en/1.11/_objects/'
}}}
''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>`.
source: http://www.sphinx-doc.org/en/stable/markup/inline.html#role-ref
For reference, I also opened a possibly related Sphinx-doc ticket about
that: https://github.com/sphinx-doc/sphinx/issues/3856
Here are a few cases of missing sections that need manual labels:
Using Sessions in views
([https://github.com/django/django/blob/01f6586/docs/topics/http/sessions.txt#L172
git], [https://docs.djangoproject.com/en/1.11/topics/http/sessions/#using-
sessions-in-views docs])
Shell ([https://github.com/django/django/blob/a30482a/docs/ref/django-
admin.txt#L971 git] [https://docs.djangoproject.com/en/1.11/ref/django-
admin/#shell docs])
--
Ticket URL: <https://code.djangoproject.com/ticket/28290>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/047.37f6917c1598daa4bbe62bbee9f5b9fe%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
