[Django] #29942: URL is broken

[Django]

#29942: URL is broken
-----------------------------------------+------------------------
Reporter: yemarnevets | Owner: nobody
Type: Bug | Status: new
Component: Uncategorized | Version: 2.1
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-----------------------------------------+------------------------
Dev URL borken:
https://docs.djangoproject.com/en/dev/_modules/django/contrib/auth/forms/

This "1.8" URL works:
https://docs.djangoproject.com/en/1.8/_modules/django/contrib/auth/forms/

But navigating to the Dev version breaks with 404

--
Ticket URL: <https://code.djangoproject.com/ticket/29942>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+------------------------------------

Reporter: yemarnevets | Owner: nobody
Type: Bug | Status: new

Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Tim Graham):

* stage: Unreviewed => Accepted
* component: Uncategorized => Documentation

Comment:

It looks like the issue started in Django 1.9. I wonder if the imports
changes in fe914341c83b37fd6aa8fd85620cf49dd2328ab0 may be at fault. I
haven't looked into how `sphinx.ext.viewcode` works.

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:1>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------------+-------------------------------------
Reporter: Yemar Nevets | Owner:
| Prabakaran Kumaresshan
Type: Bug | Status: assigned

Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Prabakaran Kumaresshan):

* owner: nobody => Prabakaran Kumaresshan
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:2>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------+------------------------------------------
Reporter: Yemar Nevets | Owner: Hasan Ramezani

Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------------
Changes (by Hasan Ramezani):

* owner: Prabakaran Kumaresshan => Hasan Ramezani
* has_patch: 0 => 1

Comment:

It is not only `contrib.auth.forms`. here are the missing source code
files list.

{{{
django/db/models/fields/related_descriptors.html
django/contrib/contenttypes/fields.html
django/contrib/contenttypes/admin.html
django/contrib/contenttypes/forms.html
django/contrib/contenttypes/models.html
django/contrib/admin/models.html
django/contrib/admin/apps.html
django/contrib/sessions/base_session.html
django/contrib/auth/validators.html
django/contrib/auth/views.html
django/contrib/auth/mixins.html
django/contrib/auth/middleware.html
django/contrib/auth/backends.html
django/contrib/auth/forms.html
django/contrib/auth/models.html
django/contrib/auth/base_user.html
}}}

from [https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
Sphinx viewcode extensions]: `Basically, viewcode extension will import
the modules being linked to`.

when Sphinx tries to do for example `import django.contrib.auth.forms`, it
will get
{{{
django.core.exceptions.ImproperlyConfigured: Requested setting
INSTALLED_APPS, but settings are not configured. You must either define
the environment variable DJANGO_SETTINGS_MODULE or call
settings.configure() before accessing settings.
}}}

So, I created a [https://github.com/django/django/pull/12135 PR] to load
the apps in [https://github.com/django/django/blob/master/docs/conf.py].
But the `docs ` test failed. But in my local machine, it works and missed
source files generated successfully.

I don't know this is a good solution or not. just a PR to start the
discussion.

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:3>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+------------------------------------------
Reporter: Yemar Nevets | Owner: Hasan Ramezani
Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------------
Changes (by felixxm):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:4>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+--------------------------------------

Reporter: Yemar Nevets | Owner: Felix Hein

Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------
Changes (by Felix Hein):

* owner: Hasan Ramezani => Felix Hein

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:5>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+--------------------------------------
Reporter: Yemar Nevets | Owner: Felix Hein
Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------

Comment (by Felix Hein):

I spent some time trying to understand this issue and the longer I think
about it, the less clear it becomes to me which parts of the source code
should be linked to and which shouldn't.
The list of linked modules at
https://docs.djangoproject.com/en/dev/_modules/ is missing a lot of
modules, which could well be intentional. (That list is the list of files
generated by the viewcode extension, so it contains all the source code
files that are linked to somewhere in the documentation, like here:
https://docs.djangoproject.com/en/dev/ref/applications/#django.apps.AppConfig.)
The modules mentioned in this ticket have not been linked to for a long
time (and thus their source code has not been included in the
`/_modules/..` section of the documentation for that same time). So is
this maybe something that we do not actually want to link to?

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:6>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+--------------------------------------
Reporter: Yemar Nevets | Owner: Felix Hein
Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+--------------------------------------
Changes (by Zach Borboa):

* cc: Zach Borboa (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:7>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: Sarah Boyce

Type: Bug | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by Sarah Boyce):

* owner: Felix Hein => Sarah Boyce
* needs_better_patch: 1 => 0

Comment:

https://github.com/django/django/pull/16825

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:8>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------------+-------------------------------------

Reporter: Yemar Nevets | Owner: Sarah
| Boyce
Type: Bug | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):

* version: 2.1 => dev
* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:9>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------+---------------------------------------

Reporter: Yemar Nevets | Owner: Sarah Boyce
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by Sarah Boyce):

* stage: Ready for checkin => Accepted

Comment:

Updating the status to "Accepted" as edits have been pushed recently and
need a review :)

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:10>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: Sarah Boyce
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------

Comment (by David Smith):

[https://github.com/django/django/pull/16918 New PR]

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:11>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------+------------------------------------------
Reporter: Yemar Nevets | Owner: Joachim Jablon

Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------------
Changes (by Sarah Boyce):

* owner: Sarah Boyce => Joachim Jablon

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:12>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+------------------------------------------
Reporter: Yemar Nevets | Owner: Joachim Jablon
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:13>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+------------------------------------

Reporter: Yemar Nevets | Owner: (none)
Type: Bug | Status: new

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+------------------------------------
Changes (by Mariusz Felisiak):

* owner: Joachim Jablon => (none)
* status: assigned => new

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:14>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned

Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by David Smith):

* owner: (none) => David Smith

* needs_better_patch: 1 => 0

* status: new => assigned

Comment:

[https://github.com/django/django/pull/17613 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:15>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by Natalia Bidart):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:16>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by David Smith):

* needs_better_patch: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:17>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by Natalia Bidart):

* needs_better_patch: 0 => 1

* needs_tests: 0 => 1

Comment:

Setting as patch needs improvements following review from yesterday.
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:18>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by David Smith):

* needs_better_patch: 1 => 0

* needs_tests: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:19>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0

-------------------------------+---------------------------------------
Changes (by Natalia Bidart):

* needs_better_patch: 0 => 1

Comment:

Branch is pretty much ready for merge though there is a tiny pending
detail about better error reporting when calling
`importlib.util.resolve_name(name=imported_path, package=module)`. Setting
the needs improvement flag to track that item.
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:20>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

-------------------------------------+-------------------------------------

Reporter: Yemar Nevets | Owner: David
| Smith
Type: Bug | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Natalia Bidart):

* needs_better_patch: 1 => 0

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:21>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------------+-------------------------------------
Reporter: Yemar Nevets | Owner: David
| Smith

Type: Bug | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by nessita <124304+nessita@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"b691accea13da0f703728b1d62657cb7ba87da60" b691acce]:
{{{#!CommitTicketReference repository=""
revision="b691accea13da0f703728b1d62657cb7ba87da60"
Fixed #29942 -- Restored source file linking in docs by using the Sphinx
linkcode ext.

Co-authored-by: David Smith <smi...@gmail.com>
Co-authored-by: Natalia <124304+...@users.noreply.github.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:22>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
-------------------------------------+-------------------------------------
Reporter: Yemar Nevets | Owner: David
| Smith
Type: Bug | Status: closed
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Comment (by Zach Borboa):

hi. this ticket is marked fixed, but the dev URL mentioned in the
description[1] still 404s.

[1]
https://docs.djangoproject.com/en/dev/_modules/django/contrib/auth/forms/
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:23>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing

---------------------------------+---------------------------------------

Reporter: Yemar Nevets | Owner: David Smith

Type: Bug | Status: new
Component: Documentation | Version: dev
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

---------------------------------+---------------------------------------
Changes (by Tim Graham):

* resolution: fixed =>
* severity: Normal => Release blocker

* stage: Ready for checkin => Accepted

* status: closed => new

Comment:

Probably the documentation hasn't been updated since this change due to a
[https://github.com/django/django/pull/18167 Python 3.8 incompatibility].
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:24>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
---------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith

Type: Bug | Status: new

Component: Documentation | Version: dev
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

---------------------------------+---------------------------------------
Comment (by GitHub <noreply@…>):

In [changeset:"15fff62d5d8f28b6b61d63341535c9aafc64c865" 15fff62d]:
{{{#!CommitTicketReference repository=""
revision="15fff62d5d8f28b6b61d63341535c9aafc64c865"
Refs #29942 -- Fixed docs build on Python < 3.9 avoiding dict union
operator.

The docs build process was failing on djangoproject.com since it uses
Python 3.8 and the dict union operator was added in Python 3.9.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:25>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
---------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith
Type: Bug | Status: new
Component: Documentation | Version: dev
Severity: Release blocker | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+---------------------------------------

Comment (by Natalia Bidart):

Replying to [comment:23 Zach Borboa]:

> hi. this ticket is marked fixed, but the dev URL mentioned in the
description[1] still 404s.
>
> [1]
https://docs.djangoproject.com/en/dev/_modules/django/contrib/auth/forms/

Hello Zach,

As Tim mentioned, we did land a fix but it wasn't available because of a
docs build issue in our building server. We have now fixed that and the
linking to source code is available via the "[source]" link in the docs,
for example in
https://docs.djangoproject.com/en/dev/topics/auth/default/#django.contrib.auth.forms.PasswordChangeForm
there is a link to
https://github.com/django/django/blob/main/django/contrib/auth/forms.py#L488

The fix for this issue included migrating from one Sphinx extension
(viewcode) to another (linkcode), so now the docs include links to the
source code directly in GitHub.
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:26>

[Django]

#29942: viewsource links to contrib.auth.forms not appearing
---------------------------------+---------------------------------------
Reporter: Yemar Nevets | Owner: David Smith

Type: Bug | Status: closed
Component: Documentation | Version: dev
Severity: Release blocker | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
---------------------------------+---------------------------------------

Changes (by Natalia Bidart):

* resolution: => fixed
* status: new => closed

Comment:

Docs build failure fixed in 15fff62d5d8f28b6b61d63341535c9aafc64c865 and
confirmed docs now build correctly in both RTD and our server.
--
Ticket URL: <https://code.djangoproject.com/ticket/29942#comment:27>