Doc: Upgrade to Sphinx 6 (#3113)

2026-08-09 10:37:50 +00:00 · 2023-02-10 16:37:57 +01:00
parent c99df679e7
commit 6941dda489
26 changed files with 94 additions and 99 deletions
@@ -92,16 +92,14 @@
        <div class="wy-side-nav-search">
          {% block sidebartitle %}

-          {% if logo and theme_logo_only %}
-            <a href="{{ pathto('index') }}">
-          {% else %}
-            <a href="{{ pathto('index') }}" class="icon icon-home"> {{ project }}
-          {% endif %}
-
-          {% if logo %}
-            {# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
-            <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
-          {% endif %}
+          {# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #}
+          {# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #}
+          {%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %}
+          {%- set _root_doc = root_doc|default(master_doc) %}
+          <a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}>
+            {%- if logo or logo_url %}
+              <img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/>
+            {%- endif %}
          </a>

          {% include "searchbox.html" %}
@@ -2,7 +2,7 @@

 .. _`config`:

-.. spelling:: Galera
+.. spelling:word-list:: Galera

 Configuration file
 ==================
@@ -1,6 +1,6 @@
 .. highlight:: ini

-.. spelling:: SQL
+.. spelling:word-list:: SQL

 General remarks
 ===============
@@ -107,9 +107,9 @@ You can supply a valid access token as a ``Bearer``-type token in the ``Authoriz
 .. sourcecode:: http
   :emphasize-lines: 3

-       GET /api/v1/organizers/ HTTP/1.1
-       Host: pretix.eu
-       Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC
+   GET /api/v1/organizers/ HTTP/1.1
+   Host: pretix.eu
+   Authorization: Bearer i3ytqTSRWsKp16fqjekHXa4tdM4qNC

 Refreshing an access token
 --------------------------
@@ -1,4 +1,4 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin

 .. _rest-checkin:

@@ -1,4 +1,4 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin

 .. _rest-checkinlists:

@@ -1,4 +1,4 @@
-.. spelling:: fullname
+.. spelling:word-list:: fullname

 .. _`rest-devices`:

@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   geo
   lat
@@ -1,4 +1,4 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin

 Data exporters
 ==============
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   checkins
   pdf
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   checkin
   datetime
@@ -1,4 +1,4 @@
-.. spelling:: checkin
+.. spelling:word-list:: checkin

 Data shredders
 ==============
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   geo
   lat
@@ -1,4 +1,4 @@
-.. spelling:: fullname checkin
+.. spelling:word-list:: fullname checkin

 .. _`rest-teams`:

@@ -13,10 +13,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.

-from docutils.parsers.rst.directives.admonitions import BaseAdmonition
-from sphinx.util import compat
-compat.make_admonition = BaseAdmonition  # See https://github.com/spinus/sphinxcontrib-images/issues/41
-
 import sys
 import os

@@ -28,12 +24,13 @@ from datetime import date
 sys.path.insert(0, os.path.abspath('../src'))

 import django
+
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "pretix.testutils.settings")
 django.setup()

-
 try:
-    import enchant
+    import enchant  # noqa
+
    HAS_PYENCHANT = True
 except:
    HAS_PYENCHANT = False
@@ -41,7 +38,7 @@ except:
 # -- General configuration ------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'

 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -64,7 +61,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'

 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'

 # The master toctree document.
 master_doc = 'index'
@@ -79,19 +76,20 @@ copyright = '2014-{}, Raphael Michel'.format(date.today().year)
 #
 # The short X.Y version.
 from pretix import __version__
+
 version = '.'.join(__version__.split('.')[:2])
 # The full version, including alpha/beta/rc tags.
 release = __version__

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None

 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -99,34 +97,34 @@ exclude_patterns = ['_build']

 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-#default_role = None
+# default_role = None

 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True

 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True

 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False

 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []

 # If true, keep warnings as "system message" paragraphs in the built documents.
-#keep_warnings = False
+# keep_warnings = False


 # -- Options for HTML output ----------------------------------------------

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#html_theme = ""
+# html_theme = ""

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -136,14 +134,14 @@ html_theme_options = {
 }

 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []

 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None

 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None

 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
@@ -152,7 +150,7 @@ html_logo = 'images/logo-white.svg'
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -166,18 +164,18 @@ html_static_path = [
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
-#html_extra_path = []
+# html_extra_path = []

 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'

 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True

 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}

 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -192,24 +190,24 @@ html_domain_indices = False
 html_use_index = False

 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False

 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = True

 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True

 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True

 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''

 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None

 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pretixdoc'
@@ -217,47 +215,46 @@ htmlhelp_basename = 'pretixdoc'
 html_theme = 'pretix_theme'
 html_theme_path = [os.path.abspath('_themes')]

-
 # -- Options for LaTeX output ---------------------------------------------

 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
+    # The paper size ('letterpaper' or 'a4paper').
    'papersize': 'a4paper',

-# The font size ('10pt', '11pt' or '12pt').
+    # The font size ('10pt', '11pt' or '12pt').
    'pointsize': '10pt',

-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
 }

 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'pretix.tex', 'pretix Documentation',
-   'Raphael Michel', 'manual'),
+    ('index', 'pretix.tex', 'pretix Documentation',
+     'Raphael Michel', 'manual'),
 ]

 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None

 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False

 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False

 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False

 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []

 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True


 # -- Options for manual page output ---------------------------------------
@@ -270,7 +267,7 @@ man_pages = [
 ]

 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False


 # -- Options for Texinfo output -------------------------------------------
@@ -279,22 +276,22 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'pretix', 'pretix Documentation',
-   'Raphael Michel', 'pretix', 'One line description of project.',
-   'Miscellaneous'),
+    ('index', 'pretix', 'pretix Documentation',
+     'Raphael Michel', 'pretix', 'One line description of project.',
+     'Miscellaneous'),
 ]

 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []

 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True

 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'

 # If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
+# texinfo_no_detailmenu = False


 images_config = {
@@ -314,12 +311,13 @@ if HAS_PYENCHANT:
    # String specifying a file containing a list of words known to be spelled
    # correctly but that do not appear in the language dictionary selected by
    # spelling_lang. The file should contain one word per line.
-    spelling_word_list_filename='spelling_wordlist.txt'
+    spelling_word_list_filename = 'spelling_wordlist.txt'

    # Boolean controlling whether suggestions for misspelled words are printed.
    # Defaults to False.
-    spelling_show_suggestions=True
+    spelling_show_suggestions = True

    # List of filter classes to be added to the tokenizer that produces words to be checked.
    from checkin_filter import CheckinFilter
-    spelling_filters=[CheckinFilter]
+
+    spelling_filters = [CheckinFilter]
@@ -1,4 +1,4 @@
-.. spelling:: Rebase rebasing
+.. spelling:word-list:: Rebase rebasing

 Coding style and quality
 ========================
@@ -1,7 +1,7 @@
 .. highlight:: python
   :linenothreshold: 5

-.. spelling:: answ contrib
+.. spelling:word-list:: answ contrib

 Data model
 ==========
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   AGPL
   AGPLv3
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::
   Analytics

 List of plugins
@@ -1,5 +1,5 @@
 .. highlight:: ini
-.. spelling::
+.. spelling:word-list::

   IdP
   skIDentity
@@ -1,10 +1,9 @@
-sphinx==2.3.*
-jinja2==3.0.*
+sphinx==6.1.*
+jinja2==3.1.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images
-sphinxcontrib-spelling==4.*
+sphinxcontrib-spelling==7.*
 sphinxemoji
 pygments-markdown-lexer
-# See https://github.com/rfk/pyenchant/pull/130
-git+https://github.com/raphaelm/pyenchant.git@patch-1#egg=pyenchant
+pyenchant==3.2.*
@@ -1,11 +1,10 @@
 -e ../src/
-sphinx==2.3.*
-jinja2==3.0.*
+sphinx==6.1.*
+jinja2==3.1.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images
-sphinxcontrib-spelling==4.*
+sphinxcontrib-spelling==7.*
 sphinxemoji
 pygments-markdown-lexer
-# See https://github.com/rfk/pyenchant/pull/130
-git+https://github.com/raphaelm/pyenchant.git@patch-1#egg=pyenchant
+pyenchant==3.2.*
@@ -1,4 +1,4 @@
-.. spelling::
+.. spelling:word-list::

   Warengutschein
   Wertgutschein
@@ -1,7 +1,7 @@
 Invoice settings
 ================

-.. spelling:: Inv
+.. spelling:word-list:: Inv

 The settings at "Settings" → "Invoice" allow you to specify if and how pretix should generate invoices for your orders.

@@ -790,6 +790,7 @@ class ItemVariation(models.Model):
    :param require_approval: If set to ``True``, orders containing this variation can only be processed and paid after
    approval by an administrator
    :type require_approval: bool
+
    """
    item = models.ForeignKey(
        Item,
@@ -158,7 +158,7 @@ class BasePaymentProvider:
          to add the payment to the session. You are still allowed to do a redirect from ``checkout_prepare`` and then
          call this function upon return.

-        - Unlike in the general case, when ``checkout_prepare`` is called, the ``cart['total']`` parameter will _not yet_
+        - Unlike in the general case, when ``checkout_prepare`` is called, the ``cart['total']`` parameter will **not yet**
          include payment fees charged by your provider as we don't yet know the amount of the charge, so you need to
          take care of that yourself when setting your maximum amount.

@@ -847,7 +847,7 @@ class BasePaymentProvider:
        Will be called if the *ticket customer* views the details of a payment. This is
        currently used e.g. when the customer requests a refund to show which payment
        method is used for the refund. This should only include very basic information
-        about the payment, such as "VISA card ****9999", and never raw payment information.
+        about the payment, such as "VISA card ...9999", and never raw payment information.

        The default implementation returns the public name of the payment provider.