[Django] #28290: Doc sections are missing target (labels) links

classic Classic list List threaded Threaded
9 messages Options
Reply | Threaded
Open this post in threaded view
|

[Django] #28290: Doc sections are missing target (labels) links

Django
#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 [hidden email].
To post to this group, send email to [hidden email].
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.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Tony
         Type:                       |  Narlock
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:
  intersphinx                        |  Unreviewed
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Tony Narlock):

 * status:  new => assigned
 * owner:  nobody => Tony Narlock


Comment:

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

 https://docs.djangoproject.com/en/1.11/topics/http/views/#a-simple-view

 https://github.com/django/django/blob/424187e/docs/topics/http/views.txt#L15

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

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:1>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.8b3706f42bb6ccfd2a47b6a5fc77fff6%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Tony
         Type:                       |  Narlock
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Tim Graham):

 * stage:  Unreviewed => Accepted


--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:2>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.1904b2aebbe66c71f08cf3b5e19126ea%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Tony
         Type:                       |  Narlock
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Comment (by Tony Narlock):

 Another find, in the Middleware section, probably spans across other
 sections i the document too:

 https://github.com/django/django/blob/e27e4c0/docs/topics/http/middleware.txt#L98

 https://docs.djangoproject.com/en/1.11/topics/http/middleware/#activating-
 middleware

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:3>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.938ca7e2a41027e16fe613a2997fd7f1%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Tony
         Type:                       |  Narlock
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Comment (by Tony Narlock):

 http://www.sphinx-doc.org/en/stable/ext/autosectionlabel.html

 This could be of assistance.

 See https://github.com/sphinx-doc/sphinx/issues/3856

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:4>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.f6f3aac31adbedc18774ad21b1e1cb1f%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  (none)
         Type:                       |                   Status:  new
  Cleanup/optimization               |
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):

 * owner:  Tony Narlock => (none)
 * status:  assigned => new


Comment:

 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!

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:5>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.9bffe9fd457322368c721ba82936a441%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:
         Type:                       |  kamalesh0406
  Cleanup/optimization               |                   Status:  assigned
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by kamalesh0406):

 * owner:  (none) => kamalesh0406
 * status:  new => assigned


--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:6>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.0cb6f87cf6d952cacc1387faca5d7b27%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Kees Hink
         Type:                       |                   Status:  assigned
  Cleanup/optimization               |
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------
Changes (by Kees Hink):

 * owner:  Kamalesh Palanisamy => Kees Hink


Comment:

 To make sure i understand the issue correctly: What is missing is the link
 to the source code. There's a working example of such a `[source]` link in
 https://docs.djangoproject.com/en/2.2/howto/custom-management-
 commands/#django.core.management.BaseCommand. That link takes you to
 https://docs.djangoproject.com/en/2.2/_modules/django/core/management/base/#BaseCommand.
 I think this is also the intended behavior for the reported pages, because
 there's a `class` directive.

 When i follow the instruction to add a header below the `class` directive,
 i get these errors:

 {{{
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:434: WARNING:
 py:meth reference target not found: backends.base.SessionBase.flush
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:443: WARNING:
 py:meth reference target not found:
 backends.base.SessionBase.set_test_cookie
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:443: WARNING:
 py:meth reference target not found:
 backends.base.SessionBase.test_cookie_worked
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:454: WARNING:
 py:meth reference target not found:
 backends.base.SessionBase.delete_test_cookie
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:585: WARNING:
 py:meth reference target not found: backends.base.SessionBase.set_expiry
 /Users/kees/Projects/django/docs/topics/http/sessions.txt:694: WARNING:
 py:meth reference target not found:
 backends.base.SessionBase.clear_expired
 }}}

 So probably this is the right direction, but sphinx can't find all methods
 in the code. Why, i have no idea. There are no errors for the other
 referenced methods from `backends.base.SessionBase` (like
 `get_expiry_date()`).

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:7>
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 [hidden email].
To post to this group, send email to [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.bc78e85a587bbc0afe04921d161486da%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
Reply | Threaded
Open this post in threaded view
|

Re: [Django] #28290: Doc sections are missing target (labels) links

Django
In reply to this post by Django
#28290: Doc sections are missing target (labels) links
-------------------------------------+-------------------------------------
     Reporter:  Tony Narlock         |                    Owner:  Kees Hink
         Type:                       |                   Status:  assigned
  Cleanup/optimization               |
    Component:  Documentation        |                  Version:  1.11
     Severity:  Normal               |               Resolution:
     Keywords:  docs labels          |             Triage Stage:  Accepted
  intersphinx                        |
    Has patch:  0                    |      Needs documentation:  0
  Needs tests:  0                    |  Patch needs improvement:  0
Easy pickings:  1                    |                    UI/UX:  0
-------------------------------------+-------------------------------------

Comment (by tapaswenipathak):

 Hello folks: Can I take the ticket?

--
Ticket URL: <https://code.djangoproject.com/ticket/28290#comment:8>
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 [hidden email].
To view this discussion on the web visit https://groups.google.com/d/msgid/django-updates/062.4418be9a78a8a3e83b1df4daed3936d8%40djangoproject.com.