Summary

Add documentation on all the Djblets settings.

Review Request #15207 — Created July 29, 2026 and updated July 29, 2026, 8:36 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This introduces a Settings guide, which covers all the settings.py
settings managed by Djblets. It's broken down into category, using the
setting:: directive provided by beanbag-docutils. As a note, these
docs are initially written by Claude, edited by me.

All references to these in existing docstrings and guides have been
updated to use the :setting: role.

Testing Done

Built the docs. Checked that the settings page's organization and
descriptions were correct. Checked the links from other doc pages
to make sure the links were correct.

Verified there were no build errors.

Commits

Summary	ID
Add documentation on all the Djblets settings. This introduces a Settings guide, which covers all the `settings.py` settings managed by Djblets. It's broken down into category, using the `setting::` directive provided by beanbag-docutils. As a note, these docs are written by Claude. All references to these in existing docstrings and guides have been updated to use the `:setting:` role.	f8d50f17e549272e098fa71f6497f1d781c34a2d

Issues

Description	From	Last Updated
line too long (82 > 79 characters) Column: 80 Error code: E501	reviewbot	July 29, 2026, 7:21 p.m.
line too long (82 > 79 characters) Column: 80 Error code: E501	reviewbot	July 29, 2026, 7:21 p.m.
line too long (82 > 79 characters) Column: 80 Error code: E501	reviewbot	July 29, 2026, 7:21 p.m.
This should be changed to be :setting:	david	July 29, 2026, 8:36 p.m.
While I was asking claude questions about this change it noticed that the name in this error message doesn't match …	david	July 29, 2026, 8:36 p.m.
This is (was already) incorrect. It only performs caching if PRODUCTION is True.	david	July 29, 2026, 8:36 p.m.
Underline isn't the right length.	david	July 29, 2026, 8:36 p.m.
There's no real default to this value. Can we say "if unset, Djblets treats the site as being served from …	david	July 29, 2026, 8:36 p.m.
This should mention the default of 60 * 60 * 24 * 30 (30 days)	david	July 29, 2026, 8:36 p.m.
This setting has existed for a long time. What 6.1 adds is the class attribute, not the setting.	david	July 29, 2026, 8:36 p.m.
Underline isn't the right length.	david	July 29, 2026, 8:36 p.m.
Underline isn't the right length.	david	July 29, 2026, 8:36 p.m.
Underline isn't the right length.	david	July 29, 2026, 8:36 p.m.
The default value is actually the ID, not the class.	david	July 29, 2026, 8:36 p.m.
The default value is actually the ID, not the class.	david	July 29, 2026, 8:36 p.m.
Typo: missing a backtick in front of "From"	david	July 29, 2026, 8:36 p.m.
Underline isn't the right length.	david	July 29, 2026, 8:36 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/cache/backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (82 > 79 characters)

Column: 80
Error code: E501
```
djblets/cache/backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (82 > 79 characters)

Column: 80
Error code: E501
```
djblets/cache/backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (82 > 79 characters)

Column: 80
Error code: E501
```

Change Summary:

Fixed line length issues.

Commits:

	Summary	ID
	Add documentation on all the Djblets settings. This introduces a Settings guide, which covers all the `settings.py` settings managed by Djblets. It's broken down into category, using the `setting::` directive provided by beanbag-docutils. As a note, these docs are written by Claude. All references to these in existing docstrings and guides have been updated to use the `:setting:` role.	bd30350a4cb2a0c91d48e95cb3fa2dad23a23aa2
	Add documentation on all the Djblets settings. This introduces a Settings guide, which covers all the `settings.py` settings managed by Djblets. It's broken down into category, using the `setting::` directive provided by beanbag-docutils. As a note, these docs are written by Claude. All references to these in existing docstrings and guides have been updated to use the `:setting:` role.	f8d50f17e549272e098fa71f6497f1d781c34a2d

Diff:

Revision 2 (+1138 -124)

Show changes

	djblets/cache/backend.py
	djblets/cache/context_processors.py
	djblets/extensions/manager.py
	djblets/features/checkers.py
	djblets/gravatars/templatetags/gravatars.py
	djblets/log/__init__.py
	djblets/log/middleware.py
	djblets/mail/message.py
	15 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Fix it!

djblets/extensions/manager.py (Diff revision 2)
An issue was opened. Show all issues
```
This should be changed to be :setting:
```

djblets/privacy/consent/tracker.py (Diff revision 2)

An issue was opened. Show all issues

While I was asking claude questions about this change it noticed that the name in this error message doesn't match the actual setting checked above.

djblets/template/loaders/conditional_cached.py (Diff revision 2)
An issue was opened. Show all issues
```
This is (was already) incorrect. It only performs caching if PRODUCTION is True.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Underline isn't the right length.
```

docs/djblets/guides/settings.rst (Diff revision 2)

An issue was opened. Show all issues

There's no real default to this value. Can we say "if unset, Djblets treats the site as being served from the domain root"?

We should also mention that if someone is using djblets.urls.context_processors.site_root, this must be explicitly set.

docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
This should mention the default of 60 * 60 * 24 * 30 (30 days)
```

docs/djblets/guides/settings.rst (Diff revision 2)

An issue was opened. Show all issues

This setting has existed for a long time. What 6.1 adds is the class attribute, not the setting.

docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Underline isn't the right length.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Underline isn't the right length.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Underline isn't the right length.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
The default value is actually the ID, not the class.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
The default value is actually the ID, not the class.
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Typo: missing a backtick in front of "From"
```
docs/djblets/guides/settings.rst (Diff revision 2)
An issue was opened. Show all issues
```
Underline isn't the right length.
```