# Documentation

**URL:** https://forum.djangoproject.com/c/internals/documentation/29.md

[Latest](https://forum.djangoproject.com/latest.md) · [Categories](https://forum.djangoproject.com/categories.md) · [Tags](https://forum.djangoproject.com/tags.md)

---

## [A more accessible home page table of contents](https://forum.djangoproject.com/t/a-more-accessible-home-page-table-of-contents/46072)

<div class="topic-metadata">

**Author:** [@evildmp](https://forum.djangoproject.com/u/evildmp)\
**Replies:** 2\
**Last updated:** [September 25, 2026, 7:32am UTC](https://forum.djangoproject.com/t/a-more-accessible-home-page-table-of-contents/46072 "2026-09-25T07:32:53Z")

</div>

@nessita @medmunds Fixed #37051 -- Improved organisation of documentation home page. by evildmp · Pull Request #21138 · django/django · GitHub has just been merged, Django documentation | Django documentation | Django . …

---

## [Proposal: let's reduce customization and use Sphinx's standard wording for version annotations](https://forum.djangoproject.com/t/proposal-lets-reduce-customization-and-use-sphinxs-standard-wording-for-version-annotations/46022)

<div class="topic-metadata">

**Author:** [@nessita](https://forum.djangoproject.com/u/nessita)\
**Replies:** 3\
**Last updated:** [September 20, 2026, 12:44am UTC](https://forum.djangoproject.com/t/proposal-lets-reduce-customization-and-use-sphinxs-standard-wording-for-version-annotations/46022 "2026-09-20T00:44:23Z")

</div>

I’m working through @medmunds PRs around improving everything related to Django docs building process and ability to switch themes. This work starts with cleaning up our custom docs/\_ext/djangodocs.py Sphinx extension, a…

---

## [Where to restate minor breaking changes in security releases?](https://forum.djangoproject.com/t/where-to-restate-minor-breaking-changes-in-security-releases/46036)

<div class="topic-metadata">

**Author:** [@jacobtylerwalls](https://forum.djangoproject.com/u/jacobtylerwalls)\
**Replies:** 18\
**Last updated:** [September 19, 2026, 7:56am UTC](https://forum.djangoproject.com/t/where-to-restate-minor-breaking-changes-in-security-releases/46036 "2026-09-19T07:56:53Z")

</div>

The Security Team tries very hard to avoid causing behavior changes in patch releases, but sometimes we have to. As the number of issues handled under the security process continues to increase\[1\], “sometimes” multiplied…

---

## [Is it safe to run migrations on SQLite in production?](https://forum.djangoproject.com/t/is-it-safe-to-run-migrations-on-sqlite-in-production/45982)

<div class="topic-metadata">

**Author:** [@villager](https://forum.djangoproject.com/u/villager)\
**Replies:** 1\
**Last updated:** [September 14, 2026, 2:56pm UTC](https://forum.djangoproject.com/t/is-it-safe-to-run-migrations-on-sqlite-in-production/45982 "2026-09-14T14:56:10Z")

</div>

Is it still standard advice to warn developers about running migrations against SQLite in a production environment? The docs state (emphasis mine): This process generally works well, but it can be slow and occasionall…

---

## [When should docs link to source files?](https://forum.djangoproject.com/t/when-should-docs-link-to-source-files/45949)

<div class="topic-metadata">

**Author:** [@rshide](https://forum.djangoproject.com/u/rshide)\
**Replies:** 1\
**Last updated:** [September 11, 2026, 10:03am UTC](https://forum.djangoproject.com/t/when-should-docs-link-to-source-files/45949 "2026-09-11T10:03:20Z")

</div>

I recently worked on ticket #37127 which ended up adding a version aware:sourcefile: Sphinx role and used it to link to Django’s builtin form templates. Now that it exists, I’m wondering if there are other instances tha…

---

## [ManyToManyField methods should also have docstrings](https://forum.djangoproject.com/t/manytomanyfield-methods-should-also-have-docstrings/45914)

<div class="topic-metadata">

**Author:** [@IgorArnaut](https://forum.djangoproject.com/u/IgorArnaut)\
**Replies:** 1\
**Last updated:** [September 4, 2026, 7:37am UTC](https://forum.djangoproject.com/t/manytomanyfield-methods-should-also-have-docstrings/45914 "2026-09-04T07:37:45Z")

</div>

item isManyToManyField. class Listing: # ... items = models.ManyToManyField(Item, related\_name="listings", blank=True) When I hover over its methods set, add, remove and clear in VS Code, their docstrings do no…

---

## [Set toc\_object\_entries=True to auto add functions/classes to the page's table of contents?](https://forum.djangoproject.com/t/set-toc-object-entries-true-to-auto-add-functions-classes-to-the-pages-table-of-contents/38902)

<div class="topic-metadata">

**Author:** [@sarahboyce](https://forum.djangoproject.com/u/sarahboyce)\
**Replies:** 9\
**Last updated:** [September 2, 2026, 1:44am UTC](https://forum.djangoproject.com/t/set-toc-object-entries-true-to-auto-add-functions-classes-to-the-pages-table-of-contents/38902 "2026-09-02T01:44:20Z")

</div>

In Django, toc\_object\_entries is set to False to disable classes/functions/attributes being added to the page’s table of contents by default (see PR). Note that toc\_object\_entries was a feature added to Sphinx 5.2 This…

---

## [Should we stop recommending pylibmc?](https://forum.djangoproject.com/t/should-we-stop-recommending-pylibmc/42993)

<div class="topic-metadata">

**Author:** [@drew](https://forum.djangoproject.com/u/drew)\
**Replies:** 8\
**Last updated:** [August 19, 2026, 7:32pm UTC](https://forum.djangoproject.com/t/should-we-stop-recommending-pylibmc/42993 "2026-08-19T19:32:20Z")

</div>

The caching docs recommend using pylibmc or pymemcache for caching using memcached. However, there’s an exception swallowed on startup under Python 3.13 that has been fixed since July 2024, but there hasn’t been a pylib…

---

## [Docs: change in the default behavior of \`manage.py check\`](https://forum.djangoproject.com/t/docs-change-in-the-default-behavior-of-manage-py-check/45780)

<div class="topic-metadata">

**Author:** [@mportesdev](https://forum.djangoproject.com/u/mportesdev)\
**Replies:** 3\
**Last updated:** [August 17, 2026, 4:09pm UTC](https://forum.djangoproject.com/t/docs-change-in-the-default-behavior-of-manage-py-check/45780 "2026-08-17T16:09:04Z")

</div>

As of Django version 6.1, the check management command runs database-related checks by default, and attempts to access all databases configured in the DATABASES setting. This backwards-incompatible change is mentioned i…

---

## [Increasing size of HTML text in django docs default theme](https://forum.djangoproject.com/t/increasing-size-of-html-text-in-django-docs-default-theme/45210)

<div class="topic-metadata">

**Author:** [@smallsaucepan](https://forum.djangoproject.com/u/smallsaucepan)\
**Replies:** 4\
**Last updated:** [June 4, 2026, 12:03am UTC](https://forum.djangoproject.com/t/increasing-size-of-html-text-in-django-docs-default-theme/45210 "2026-06-04T00:03:45Z")

</div>

The default font size in the generated HTML documentation is currently 12px. Most accessibility guidelines these days advocate 16px as a minimum, especially for text heavy content. I feel the current size makes the docu…

---

## [First impressions on documentation about new feature system / informal votes](https://forum.djangoproject.com/t/first-impressions-on-documentation-about-new-feature-system-informal-votes/45140)

<div class="topic-metadata">

**Author:** [@StephanieAG](https://forum.djangoproject.com/u/StephanieAG)\
**Replies:** 2\
**Last updated:** [May 23, 2026, 1:17pm UTC](https://forum.djangoproject.com/t/first-impressions-on-documentation-about-new-feature-system-informal-votes/45140 "2026-05-23T13:17:14Z")

</div>

Was poking around following links from the new feature process page to the new feature GitHub repo and the below two excerpts were confusing for me at first read: Django contributing docs section for How we make decisio…

---

## [Official MCP Server for Django's documentation](https://forum.djangoproject.com/t/official-mcp-server-for-djangos-documentation/44188)

<div class="topic-metadata">

**Author:** [@Akash-Kumar-Sen](https://forum.djangoproject.com/u/Akash-Kumar-Sen)\
**Replies:** 5\
**Last updated:** [May 12, 2026, 6:28pm UTC](https://forum.djangoproject.com/t/official-mcp-server-for-djangos-documentation/44188 "2026-05-12T18:28:33Z")

</div>

Problem Exposing Django’s official documentation with an MCP server that can be deployed locally or can be used from a remote dedicated URL like mcp.djangoproject.com can help the LLM or agents that developers are using…

---

## [Proposal: New documentation page covering using Django with type hints](https://forum.djangoproject.com/t/proposal-new-documentation-page-covering-using-django-with-type-hints/45004)

<div class="topic-metadata">

**Author:** [@anorthall](https://forum.djangoproject.com/u/anorthall)\
**Replies:** 6\
**Last updated:** [April 29, 2026, 4:59am UTC](https://forum.djangoproject.com/t/proposal-new-documentation-page-covering-using-django-with-type-hints/45004 "2026-04-29T04:59:22Z")

</div>

Hi all! Only me here, just talking about how Django doesn’t support static analysis very well and that it doesn’t have many type hints. But, don’t worry, I’m not proposing that we add any! Pitchforks down. This thread …

---

## [A series of documentation improvements](https://forum.djangoproject.com/t/a-series-of-documentation-improvements/44938)

<div class="topic-metadata">

**Author:** [@evildmp](https://forum.djangoproject.com/u/evildmp)\
**Replies:** 0\
**Last updated:** [April 19, 2026, 1:40pm UTC](https://forum.djangoproject.com/t/a-series-of-documentation-improvements/44938 "2026-04-19T13:40:58Z")

</div>

I would like to make a series of improvements to the Django documentation, at a structural level. At Django on the Med in Spain in October 2025 I got started with some work, but it’s only now at the DjangoCon Europe 202…

---

## ["Don't accept your own tickets"](https://forum.djangoproject.com/t/dont-accept-your-own-tickets/44867)

<div class="topic-metadata">

**Author:** [@villager](https://forum.djangoproject.com/u/villager)\
**Replies:** 3\
**Last updated:** [April 17, 2026, 5:40am UTC](https://forum.djangoproject.com/t/dont-accept-your-own-tickets/44867 "2026-04-17T05:40:44Z")

</div>

Don’t accept your own tickets The unwritten rule of contributing to Django. There are numerous examples of maintainers and Fellows asking contributors to not accept their own tickets. It is not explicitly written in t…

---

## [Rename documentation files from \`.txt\` to \`.rst\`](https://forum.djangoproject.com/t/rename-documentation-files-from-txt-to-rst/39699)

<div class="topic-metadata">

**Author:** [@adamchainz](https://forum.djangoproject.com/u/adamchainz)\
**Replies:** 16\
**Last updated:** [April 5, 2026, 10:08pm UTC](https://forum.djangoproject.com/t/rename-documentation-files-from-txt-to-rst/39699 "2026-04-05T22:08:07Z")

</div>

13 years ago, Ticket #18448 proposed renaming the docs files from .txt to .rst, so editors and GitHub would automatically use reStructuredText syntax highlighting and other features. @jacobian closed it as wontfix it at …

---

## [Missing docs about new django.contrib.postgres system check from #32770](https://forum.djangoproject.com/t/missing-docs-about-new-django-contrib-postgres-system-check-from-32770/44846)

<div class="topic-metadata">

**Author:** [@ericmassip](https://forum.djangoproject.com/u/ericmassip)\
**Replies:** 2\
**Last updated:** [April 5, 2026, 4:38pm UTC](https://forum.djangoproject.com/t/missing-docs-about-new-django-contrib-postgres-system-check-from-32770/44846 "2026-04-05T16:38:11Z")

</div>

Hi! I came across the system check introduced in #32770 because we were using ArrayField and did not have ‘django.contrib.postgres’ in INSTALLED\_APPS. I checked the docs and this detail is a bit scattered. I wasn’t abl…

---

## [Discouraging "the voice from nowhere" (~LLMs) in documentation](https://forum.djangoproject.com/t/discouraging-the-voice-from-nowhere-llms-in-documentation/44699)

<div class="topic-metadata">

**Author:** [@jacobtylerwalls](https://forum.djangoproject.com/u/jacobtylerwalls)\
**Replies:** 10\
**Last updated:** [March 27, 2026, 4:04pm UTC](https://forum.djangoproject.com/t/discouraging-the-voice-from-nowhere-llms-in-documentation/44699 "2026-03-27T16:04:30Z")

</div>

Django’s documentation is one of its greatest value propositions. While the sentiment may not be universal, I hear it even from first-time bug reporters, who embellish reports with comments such as, “love the framework, …

---

## [Adopting Contributor Covenant 3 as our new Code of Conduct](https://forum.djangoproject.com/t/adopting-contributor-covenant-3-as-our-new-code-of-conduct/44530)

<div class="topic-metadata">

**Author:** [@dryan](https://forum.djangoproject.com/u/dryan)\
**Replies:** 0\
**Last updated:** [March 16, 2026, 2:13pm UTC](https://forum.djangoproject.com/t/adopting-contributor-covenant-3-as-our-new-code-of-conduct/44530 "2026-03-16T14:13:28Z")

</div>

The Code of Conduct Working Group has been on a multi-month project to propose adopting Contributor Covenant 3 as Django’s Code of Conduct. To that end we have opened a pull request to make the text changes to our CoC. A…

---

## [Updating the Code of Conduct's process documentation](https://forum.djangoproject.com/t/updating-the-code-of-conducts-process-documentation/44186)

<div class="topic-metadata">

**Author:** [@dryan](https://forum.djangoproject.com/u/dryan)\
**Replies:** 0\
**Last updated:** [February 13, 2026, 5:06pm UTC](https://forum.djangoproject.com/t/updating-the-code-of-conducts-process-documentation/44186 "2026-02-13T17:06:49Z")

</div>

As the next step in the process we announced last month, the Code of Conduct Working Group has opened a new pull request that gets our documentation modernized and accurate to how we work now. As before we welcome your f…

---

## [Request to mention to \*\*not\*\* use QueryDict in unittest Client.post](https://forum.djangoproject.com/t/request-to-mention-to-not-use-querydict-in-unittest-client-post/44179)

<div class="topic-metadata">

**Author:** [@defgsus](https://forum.djangoproject.com/u/defgsus)\
**Replies:** 0\
**Last updated:** [February 13, 2026, 9:04am UTC](https://forum.djangoproject.com/t/request-to-mention-to-not-use-querydict-in-unittest-client-post/44179 "2026-02-13T09:04:36Z")

</div>

Hi there, i was writing some unit-tests for a django-admin based software interacting with the changelist view. The test involves selecting a few rows and calling an action, so there is code like: from django.http impo…

---

## [I miss Django](https://forum.djangoproject.com/t/i-miss-django/44138)

<div class="topic-metadata">

**Author:** [@JCast867](https://forum.djangoproject.com/u/JCast867)\
**Replies:** 1\
**Last updated:** [February 11, 2026, 10:28am UTC](https://forum.djangoproject.com/t/i-miss-django/44138 "2026-02-11T10:28:40Z")

</div>

I wanted to come here and share my experience with moving away from Django. My job recently required us to switch to Go, using Gin and Gorm, and after about a month I can confidently say how much I miss Django. In parti…

---

## [FileField null=True unique=True](https://forum.djangoproject.com/t/filefield-null-true-unique-true/43931)

<div class="topic-metadata">

**Author:** [@bery](https://forum.djangoproject.com/u/bery)\
**Replies:** 3\
**Last updated:** [January 15, 2026, 11:48am UTC](https://forum.djangoproject.com/t/filefield-null-true-unique-true/43931 "2026-01-15T11:48:29Z")

</div>

Seems like FileField / ImageField cannot have null=True + unique=True I’m testing this on sqlite and I get IntegrityError: UNIQUE constraint failed for multiple rows without a file. FieldFile seems to always save empty…

---

## [Request for RSGI protocol to be acknowledged in docs](https://forum.djangoproject.com/t/request-for-rsgi-protocol-to-be-acknowledged-in-docs/43867)

<div class="topic-metadata">

**Author:** [@anadon](https://forum.djangoproject.com/u/anadon)\
**Replies:** 1\
**Last updated:** [January 10, 2026, 6:41pm UTC](https://forum.djangoproject.com/t/request-for-rsgi-protocol-to-be-acknowledged-in-docs/43867 "2026-01-10T18:41:05Z")

</div>

Looking into Granian, it would be nice if the Django documentation made explicit mention of RSGI as described in granian/docs/spec/RSGI.md at master · emmett-framework/granian · GitHub . Right now, It’d be a flat “not s…

---

## [Report a document translation error in zh-hans](https://forum.djangoproject.com/t/report-a-document-translation-error-in-zh-hans/43892)

<div class="topic-metadata">

**Author:** [@hkkxx](https://forum.djangoproject.com/u/hkkxx)\
**Replies:** 0\
**Last updated:** [January 10, 2026, 5:11pm UTC](https://forum.djangoproject.com/t/report-a-document-translation-error-in-zh-hans/43892 "2026-01-10T17:11:09Z")

</div>

Please see the marked area in the image. The translation is ambiguous and carries sexual innuendo in today’s online environment; it’s a obviously vulgar expression. If it was a human translator, I believe this is mal…

---

## [Generate llms.txt file for Django docs, ie: make Django AI friendly](https://forum.djangoproject.com/t/generate-llms-txt-file-for-django-docs-ie-make-django-ai-friendly/40672)

<div class="topic-metadata">

**Author:** [@Benoit](https://forum.djangoproject.com/u/Benoit)\
**Replies:** 10\
**Last updated:** [January 4, 2026, 9:19am UTC](https://forum.djangoproject.com/t/generate-llms-txt-file-for-django-docs-ie-make-django-ai-friendly/40672 "2026-01-04T09:19:23Z")

</div>

LLMs are smart but when helping them you get much better results. Django documentation is well indexed by LLMs but it can be hard for LLMs to manage multiple versions at the same time and they are often confused with ol…

---

## [Django 6.0 PDF Documentation Not Downloading](https://forum.djangoproject.com/t/django-6-0-pdf-documentation-not-downloading/43688)

<div class="topic-metadata">

**Author:** [@WhitewaterDave](https://forum.djangoproject.com/u/WhitewaterDave)\
**Replies:** 9\
**Last updated:** [December 22, 2025, 1:20pm UTC](https://forum.djangoproject.com/t/django-6-0-pdf-documentation-not-downloading/43688 "2025-12-22T13:20:37Z")

</div>

Minor issue with downloadable documentation. There is an issue with Django 6.0 PDF Documentation not downloading. It downloads a partial PDF file and never finished. I’ve tried downloading it on three different systems w…

---

## [6.0 Documentation confusion for django tasks.](https://forum.djangoproject.com/t/6-0-documentation-confusion-for-django-tasks/43583)

<div class="topic-metadata">

**Author:** [@nanorepublica](https://forum.djangoproject.com/u/nanorepublica)\
**Replies:** 9\
**Last updated:** [December 16, 2025, 3:53pm UTC](https://forum.djangoproject.com/t/6-0-documentation-confusion-for-django-tasks/43583 "2025-12-16T15:53:39Z")

</div>

Over on the discord server we have had more than a few people excited and then confused about the new tasks framework coming in Django 6.0. The confusion mainly comes from mismatched expectations from those that have not…

---

## [Package versus module](https://forum.djangoproject.com/t/package-versus-module/43560)

<div class="topic-metadata">

**Author:** [@bkline](https://forum.djangoproject.com/u/bkline)\
**Replies:** 2\
**Last updated:** [November 28, 2025, 4:44pm UTC](https://forum.djangoproject.com/t/package-versus-module/43560 "2025-11-28T16:44:35Z")

</div>

The topic page for Models has a paragraph which says: Once you have defined your models, you need to tell Django you’re going to use those models. Do this by editing your settings file and changing the INSTALLED\_APPS s…

---

## [Inconsistent source links in the docs](https://forum.djangoproject.com/t/inconsistent-source-links-in-the-docs/43501)

<div class="topic-metadata">

**Author:** [@stuartmaxwell](https://forum.djangoproject.com/u/stuartmaxwell)\
**Replies:** 2\
**Last updated:** [November 23, 2025, 5:34pm UTC](https://forum.djangoproject.com/t/inconsistent-source-links-in-the-docs/43501 "2025-11-23T17:34:17Z")

</div>

I find the “source” links in the docs really useful, but noticed that some pages in the docs have no source links, while in other places some functions will have source links and not others. I can’t tell how the source …

[Next page](https://forum.djangoproject.com/c/internals/documentation/29.md?page=1)
