[Django] #33247: PDF documentation build broken
Django
-----------------------------------------+------------------------
Reporter: AndrewN | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 3.2
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 |
-----------------------------------------+------------------------
https://readthedocs.org/projects/django/builds/ shows that PDF builds of
the docs are failing.
The error message in a log from a recent build:
{{{
File
"/home/docs/checkouts/readthedocs.org/user_builds/django/checkouts/latest/django/__init__.py",
line 1, in <module>
from django.utils.version import get_version
File
"/home/docs/checkouts/readthedocs.org/user_builds/django/checkouts/latest/django/utils/version.py",
line 73, in <module>
@functools.lru_cache
File
"/home/docs/checkouts/readthedocs.org/user_builds/django/envs/latest/lib/python3.7/functools.py",
line 490, in lru_cache
raise TypeError('Expected maxsize to be an integer or None')
TypeError: Expected maxsize to be an integer or None
}}}
The [https://buildmedia.readthedocs.org/media/pdf/django/latest/django.pdf
last generated PDF] has a date of September 27 and on that date in
5bac1719a2fcb “Refs #32355 -- Used @functools.lru_cache as a straight
decorator”, `lru_cache()` was changed to `lru_cache` on that line.
I believe the issue is that readthedocs is currently using a too-old
version of python for the documentation build.
--
Ticket URL: <https://code.djangoproject.com/ticket/33247>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: AndrewN | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 3.2
Keywords: | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by AndrewN):
* has_patch: 0 => 1
Comment:
PR: https://github.com/django/django/pull/15039
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:1>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: assigned
Component: Documentation | Version: 3.2
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 Carlton Gibson):
* owner: nobody => AndrewN
* status: new => assigned
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:2>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak):
Is seems that "Read The Docs" uses quite old Sphinx `1.8.5` by default, we
should install at least [https://pypi.org/project/Sphinx/3.1.0/ 3.1.0] to
get support for Python 3.8. See
[https://readthedocs.org/projects/django/builds/15170239/ logs].
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:3>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by GitHub <noreply@…>):
In [changeset:"447b6c866f0741bb68c92dc925a65fb15bfe7995" 447b6c86]:
{{{
#!CommitTicketReference repository=""
revision="447b6c866f0741bb68c92dc925a65fb15bfe7995"
Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by
RTD is not compatible with Python 3.8+.
This also, sets Python 3.8 for RTD builds which is compatible with all
current versions of Django.
Thanks to Mariusz Felisiak for the suggestion.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:4>
Django
Reporter: AndrewN | Owner: AndrewN
Component: Documentation | Version: 3.2
Severity: Normal | 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 Mariusz Felisiak):
* status: assigned => closed
* resolution: => fixed
Comment:
In
[https://github.com/django/django/commit/0da7a2e9dab81b622a2000536c6a96de7f46e237
0da7a2e9dab81b622a2000536c6a96de7f46e237]
Fixed #33247 -- Added configuration for Read The Docs.
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:5>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"2877d26448f872cf7f6b7b9168e138f730acad87" 2877d264]:
{{{
#!CommitTicketReference repository=""
revision="2877d26448f872cf7f6b7b9168e138f730acad87"
[4.0.x] Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by
RTD is not compatible with Python 3.8+.
This also, sets Python 3.8 for RTD builds which is compatible with all
current versions of Django.
Thanks to Mariusz Felisiak for the suggestion.
Backport of 447b6c866f0741bb68c92dc925a65fb15bfe7995 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:7>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"df452a226e67a8f27e91810b54c369b94f6b6ccf" df452a22]:
{{{
#!CommitTicketReference repository=""
revision="df452a226e67a8f27e91810b54c369b94f6b6ccf"
[4.0.x] Fixed #33247 -- Added configuration for Read The Docs.
Co-authored-by: Andrew Neitsch <and...@neitsch.ca>
Backport of 0da7a2e9dab81b622a2000536c6a96de7f46e237 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:6>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"9d171643d468aee2d61bf46cebfcbfe96df41d2d" 9d171643]:
{{{
#!CommitTicketReference repository=""
revision="9d171643d468aee2d61bf46cebfcbfe96df41d2d"
[3.2.x] Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by
RTD is not compatible with Python 3.8+.
This also, sets Python 3.8 for RTD builds which is compatible with all
current versions of Django.
Thanks to Mariusz Felisiak for the suggestion.
Backport of 447b6c866f0741bb68c92dc925a65fb15bfe7995 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:9>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"327dac6e7ce630d80111f48f29984bae8ca304d7" 327dac6e]:
{{{
#!CommitTicketReference repository=""
revision="327dac6e7ce630d80111f48f29984bae8ca304d7"
[3.2.x] Fixed #33247 -- Added configuration for Read The Docs.
Co-authored-by: Andrew Neitsch <and...@neitsch.ca>
Backport of 0da7a2e9dab81b622a2000536c6a96de7f46e237 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:8>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"9a4a2b20897b9cbddff9e024f3d814e105ab8d57" 9a4a2b20]:
{{{
#!CommitTicketReference repository=""
revision="9a4a2b20897b9cbddff9e024f3d814e105ab8d57"
[2.2.x] Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by
RTD is not compatible with Python 3.8+.
This also, sets Python 3.8 for RTD builds which is compatible with all
current versions of Django.
Thanks to Mariusz Felisiak for the suggestion.
Backport of 447b6c866f0741bb68c92dc925a65fb15bfe7995 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:11>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"029c830b71ee7a364c182d0746224e94f78f93c9" 029c830b]:
{{{
#!CommitTicketReference repository=""
revision="029c830b71ee7a364c182d0746224e94f78f93c9"
[2.2.x] Fixed #33247 -- Added configuration for Read The Docs.
Co-authored-by: Andrew Neitsch <and...@neitsch.ca>
Backport of 0da7a2e9dab81b622a2000536c6a96de7f46e237 from main
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:10>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Mariusz Felisiak <felisiak.mariusz@…>):
In [changeset:"95a4db3fbd946dd56f46f4c8c22be3b28083d845" 95a4db3]:
{{{
#!CommitTicketReference repository=""
revision="95a4db3fbd946dd56f46f4c8c22be3b28083d845"
Refs #33247 -- Fixed rendering of Unicode chars and emojis in PDF docs
build.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:12>
Django
Reporter: AndrewN | Owner: AndrewN
Type: Bug | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Comment (by GitHub <noreply@…>):
In [changeset:"adb4100e58d9ea073ee8caa454bb7c885b6a83ed" adb4100e]:
{{{
#!CommitTicketReference repository=""
revision="adb4100e58d9ea073ee8caa454bb7c885b6a83ed"
Refs #33247 -- Used XeLaTeX for PDF docs build.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33247#comment:13>