Skip to content

Commit

Permalink
Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --…
Browse files Browse the repository at this point in the history
…fail-on-warning switch
  • Loading branch information
gasman committed Jul 23, 2024
1 parent 80b1ebe commit f7fa20e
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

# You can set these variables from the command line.
SPHINXOPTS = -W -n -jauto
SPHINXOPTS = --fail-on-warning -n -jauto
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced_topics/images/custom_image_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,12 @@ The following methods can be overridden on your custom `Image` or `Rendition` mo
:no-index:
.. class:: AbstractImage
:noindexentry:
:no-index-entry:
.. automethod:: get_upload_to
.. class:: AbstractRendition
:noindexentry:
:no-index-entry:
.. automethod:: get_upload_to
```
Expand Down
26 changes: 13 additions & 13 deletions docs/reference/pages/model_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ See also [django-treebeard](https://django-treebeard.readthedocs.io/en/latest/in

```{eval-rst}
.. class:: Page
:noindex:
:no-index:
.. automethod:: get_specific
Expand Down Expand Up @@ -444,7 +444,7 @@ The {meth}`~wagtail.models.Site.find_for_request` function returns the Site obje

```{eval-rst}
.. class:: Site
:noindex:
:no-index:
.. automethod:: find_for_request
Expand Down Expand Up @@ -546,7 +546,7 @@ If your model defines a [`Meta` class](inv:django#ref/models/options) (either wi

```{eval-rst}
.. class:: TranslatableMixin
:noindex:
:no-index:
.. automethod:: get_translations
Expand Down Expand Up @@ -607,7 +607,7 @@ Pages already include this mixin, so there is no need to add it.

```{eval-rst}
.. class:: RevisionMixin
:noindex:
:no-index:
.. autoattribute:: revisions
Expand Down Expand Up @@ -665,7 +665,7 @@ This mixin requires {class}`~wagtail.models.RevisionMixin` to be applied. Pages

```{eval-rst}
.. class:: DraftStateMixin
:noindex:
:no-index:
.. automethod:: publish
Expand Down Expand Up @@ -707,7 +707,7 @@ Pages already include this mixin, so there is no need to add it. See [](wagtails

```{eval-rst}
.. class:: LockableMixin
:noindex:
:no-index:
.. automethod:: get_lock
Expand Down Expand Up @@ -805,7 +805,7 @@ You can use the [`purge_revisions`](purge_revisions) command to delete old revis

```{eval-rst}
.. class:: Revision
:noindex:
:no-index:
.. attribute:: objects
Expand Down Expand Up @@ -833,7 +833,7 @@ You can use the [`purge_revisions`](purge_revisions) command to delete old revis

```{eval-rst}
.. class:: Revision
:noindex:
:no-index:
.. automethod:: as_object
Expand Down Expand Up @@ -928,7 +928,7 @@ Workflows represent sequences of tasks that must be approved for an action to be

```{eval-rst}
.. class:: Workflow
:noindex:
:no-index:
.. automethod:: start
Expand Down Expand Up @@ -1007,7 +1007,7 @@ Workflow states represent the status of a started workflow on an object.

```{eval-rst}
.. class:: WorkflowState
:noindex:
:no-index:
.. attribute:: STATUS_CHOICES
Expand Down Expand Up @@ -1064,7 +1064,7 @@ Tasks represent stages in a workflow that must be approved for the workflow to c

```{eval-rst}
.. class:: Task
:noindex:
:no-index:
.. autoattribute:: workflows
Expand Down Expand Up @@ -1171,7 +1171,7 @@ Task states store state information about the progress of a task on a particular

```{eval-rst}
.. class:: TaskState
:noindex:
:no-index:
.. attribute:: STATUS_CHOICES
Expand Down Expand Up @@ -1325,7 +1325,7 @@ An abstract base class that represents a record of an action performed on an obj

```{eval-rst}
.. class:: BaseLogEntry
:noindex:
:no-index:
.. autoattribute:: user_display_name
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
documentation_extras = [
"pyenchant>=3.1.1,<4",
"sphinxcontrib-spelling>=7,<8",
"Sphinx>=7.0",
"Sphinx>=7.3",
"sphinx-autobuild>=0.6.0",
"sphinx-wagtail-theme==6.3.0",
"myst_parser==2.0.0",
Expand Down

0 comments on commit f7fa20e

Please sign in to comment.