diff options
| author | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2022-05-31 07:40:54 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2022-06-27 08:04:25 +0200 |
| commit | 4d20d2f7c2b8e74c3e85bd0716ebdcb3b35a70e6 (patch) | |
| tree | 40722f3317489da559dce2c04da404f1fe61709d /docs/ref | |
| parent | 8a294ee2e0e30f073f764310c74899e385a302ec (diff) | |
[4.0.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.txt | 10 | ||||
| -rw-r--r-- | docs/ref/contrib/admin/javascript.txt | 4 | ||||
| -rw-r--r-- | docs/ref/databases.txt | 8 | ||||
| -rw-r--r-- | docs/ref/models/expressions.txt | 2 | ||||
| -rw-r--r-- | docs/ref/models/fields.txt | 4 | ||||
| -rw-r--r-- | docs/ref/templates/language.txt | 8 |
6 files changed, 18 insertions, 18 deletions
diff --git a/docs/ref/contrib/admin/index.txt b/docs/ref/contrib/admin/index.txt index 1d47da5a7e..4c59b90128 100644 --- a/docs/ref/contrib/admin/index.txt +++ b/docs/ref/contrib/admin/index.txt @@ -3115,7 +3115,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 import admin @@ -3129,7 +3129,7 @@ to reference your :class:`AdminSite` subclass. .. code-block:: python - :caption: myproject/urls.py + :caption: ``myproject/urls.py`` from django.urls import path @@ -3156,7 +3156,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 @@ -3164,7 +3164,7 @@ returns a site instance. ... .. code-block:: python - :caption: myproject/apps.py + :caption: ``myproject/apps.py`` from django.contrib.admin.apps import AdminConfig @@ -3172,7 +3172,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 0f183bfe20..ba5692d9e5 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -120,7 +120,7 @@ password from the `password file`_, you must specify them in the :setting:`OPTIONS` part of your database configuration in :setting:`DATABASES`: .. code-block:: python - :caption: settings.py + :caption: ``settings.py`` DATABASES = { 'default': { @@ -133,7 +133,7 @@ password from the `password file`_, you must specify them in the } .. code-block:: text - :caption: .pg_service.conf + :caption: ``.pg_service.conf`` [my_service] host=localhost @@ -142,7 +142,7 @@ password from the `password file`_, you must specify them in the port=5432 .. code-block:: text - :caption: .my_pgpass + :caption: ``.my_pgpass`` localhost:5432:NAME:USER:PASSWORD @@ -1079,7 +1079,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 a47e35b110..df1d93a752 100644 --- a/docs/ref/models/expressions.txt +++ b/docs/ref/models/expressions.txt @@ -335,7 +335,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 608ec2d709..e5767c450e 100644 --- a/docs/ref/models/fields.txt +++ b/docs/ref/models/fields.txt @@ -1470,7 +1470,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 @@ -1481,7 +1481,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 ffddd7435a..92fcb0b642 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 & 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 }} |
