summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorMariusz Felisiak <felisiak.mariusz@gmail.com>2022-05-31 07:40:54 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2022-06-27 08:10:48 +0200
commit1a9098166e58704b11dcf088948efa89e088b6f5 (patch)
tree47fb0eb85fc0df42ddbaf7d4e1dee132c610177f /docs/ref
parent37f4de2deb12465f8ff8bcb2fd1c20a904cb8f2b (diff)
[3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set of nodes for which the text is checked. Backport of ac90529cc58507d9a07610809a795ec5fc3cbf8c from main.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/admin/index.txt10
-rw-r--r--docs/ref/contrib/admin/javascript.txt4
-rw-r--r--docs/ref/databases.txt2
-rw-r--r--docs/ref/models/expressions.txt2
-rw-r--r--docs/ref/models/fields.txt4
-rw-r--r--docs/ref/templates/language.txt8
6 files changed, 15 insertions, 15 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt
index 4bafc5e1b8..7a51d11061 100644
--- a/docs/ref/contrib/admin/index.txt
+++ b/docs/ref/contrib/admin/index.txt
@@ -3093,7 +3093,7 @@ it instead of with the default site. Finally, update :file:`myproject/urls.py`
to reference your :class:`AdminSite` subclass.
.. code-block:: python
- :caption: myapp/admin.py
+ :caption: ``myapp/admin.py``
from django.contrib.admin import AdminSite
@@ -3107,7 +3107,7 @@ to reference your :class:`AdminSite` subclass.
.. code-block:: python
- :caption: myproject/urls.py
+ :caption: ``myproject/urls.py``
from django.urls import path
@@ -3134,7 +3134,7 @@ to the dotted import path of either a ``AdminSite`` subclass or a callable that
returns a site instance.
.. code-block:: python
- :caption: myproject/admin.py
+ :caption: ``myproject/admin.py``
from django.contrib import admin
@@ -3142,7 +3142,7 @@ returns a site instance.
...
.. code-block:: python
- :caption: myproject/apps.py
+ :caption: ``myproject/apps.py``
from django.contrib.admin.apps import AdminConfig
@@ -3150,7 +3150,7 @@ returns a site instance.
default_site = 'myproject.admin.MyAdminSite'
.. code-block:: python
- :caption: myproject/settings.py
+ :caption: ``myproject/settings.py``
INSTALLED_APPS = [
...
diff --git a/docs/ref/contrib/admin/javascript.txt b/docs/ref/contrib/admin/javascript.txt
index 05731c57b0..9645f6abbc 100644
--- a/docs/ref/contrib/admin/javascript.txt
+++ b/docs/ref/contrib/admin/javascript.txt
@@ -32,7 +32,7 @@ In your custom ``change_form.html`` template, extend the
{% endblock %}
.. code-block:: javascript
- :caption: app/static/app/formset_handlers.js
+ :caption: ``app/static/app/formset_handlers.js``
(function($) {
$(document).on('formset:added', function(event, $row, formsetName) {
@@ -70,7 +70,7 @@ listen to the event triggered from there. For example:
{% endblock %}
.. code-block:: javascript
- :caption: app/static/app/unregistered_handlers.js
+ :caption: ``app/static/app/unregistered_handlers.js``
django.jQuery(document).on('formset:added', function(event, $row, formsetName) {
// Row added
diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt
index 89341ad798..24aa732462 100644
--- a/docs/ref/databases.txt
+++ b/docs/ref/databases.txt
@@ -1033,7 +1033,7 @@ example of subclassing the PostgreSQL engine to change a feature class
``allows_group_by_selected_pks_on_model``:
.. code-block:: python
- :caption: mysite/mydbengine/base.py
+ :caption: ``mysite/mydbengine/base.py``
from django.db.backends.postgresql import base, features
diff --git a/docs/ref/models/expressions.txt b/docs/ref/models/expressions.txt
index 236918380e..e84a729f6e 100644
--- a/docs/ref/models/expressions.txt
+++ b/docs/ref/models/expressions.txt
@@ -327,7 +327,7 @@ The ``Func`` API is as follows:
customize the SQL as needed. For example:
.. code-block:: python
- :caption: django/db/models/functions.py
+ :caption: ``django/db/models/functions.py``
class ConcatPair(Func):
...
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 3d671a9aac..62954b1f48 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1478,7 +1478,7 @@ Relationships defined this way on :ref:`abstract models
concrete model and are not relative to the abstract model's ``app_label``:
.. code-block:: python
- :caption: products/models.py
+ :caption: ``products/models.py``
from django.db import models
@@ -1489,7 +1489,7 @@ concrete model and are not relative to the abstract model's ``app_label``:
abstract = True
.. code-block:: python
- :caption: production/models.py
+ :caption: ``production/models.py``
from django.db import models
from products.models import AbstractCar
diff --git a/docs/ref/templates/language.txt b/docs/ref/templates/language.txt
index 04b363c0cf..cc627373b2 100644
--- a/docs/ref/templates/language.txt
+++ b/docs/ref/templates/language.txt
@@ -564,7 +564,7 @@ current one as well as templates included via the :ttag:`include` tag,
just like all block tags. For example:
.. code-block:: html+django
- :caption: base.html
+ :caption: ``base.html``
{% autoescape off %}
<h1>{% block title %}{% endblock %}</h1>
@@ -573,7 +573,7 @@ just like all block tags. For example:
{% endautoescape %}
.. code-block:: html+django
- :caption: child.html
+ :caption: ``child.html``
{% extends "base.html" %}
{% block title %}This &amp; that{% endblock %}
@@ -653,14 +653,14 @@ of all comments related to the current task with::
You can also access methods you've explicitly defined on your own models:
.. code-block:: python
- :caption: models.py
+ :caption: ``models.py``
class Task(models.Model):
def foo(self):
return "bar"
.. code-block:: html+django
- :caption: template.html
+ :caption: ``template.html``
{{ task.foo }}