Docs: Fix various sphinx warnings

This commit is contained in:
Raphael Michel
2024-10-25 21:58:00 +02:00
parent 6e0613a2af
commit 5795aa6492
12 changed files with 24 additions and 12 deletions

View File

@@ -977,8 +977,8 @@ Creating orders
* ``internal_reference`` * ``internal_reference``
* ``vat_id`` * ``vat_id``
* ``vat_id_validated`` (optional) If you need support for reverse charge (rarely the case), you need to check * ``vat_id_validated`` (optional) If you need support for reverse charge (rarely the case), you need to check
yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will yourself if the passed VAT ID is a valid EU VAT ID. In that case, set this to ``true``. Only valid VAT IDs will
trigger reverse charge taxation. Don't forget to set ``is_business`` as well! trigger reverse charge taxation. Don't forget to set ``is_business`` as well!
* ``positions`` * ``positions``

View File

@@ -313,7 +313,7 @@ Endpoints for event exports
:statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource. :statuscode 403: The requested organizer/event does not exist **or** you have no permission to delete this resource.
Endpoints for organizer exports Endpoints for organizer exports
--------------------------- -------------------------------
.. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/ .. http:get:: /api/v1/organizers/(organizer)/scheduled_exports/

View File

@@ -1,4 +1,4 @@
.. _`rest-reusablemedia`: .. _`rest-seats`:
Seats Seats
===== =====

View File

@@ -17,6 +17,7 @@ First, you need to declare that you are using non-essential cookies by respondin
signal: signal:
.. automodule:: pretix.presale.signals .. automodule:: pretix.presale.signals
:no-index:
:members: register_cookie_providers :members: register_cookie_providers
You are expected to return a list of ``CookieProvider`` objects instantiated from the following class: You are expected to return a list of ``CookieProvider`` objects instantiated from the following class:

View File

@@ -22,12 +22,14 @@ Order events
There are multiple signals that will be sent out in the ordering cycle: There are multiple signals that will be sent out in the ordering cycle:
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text :members: validate_cart, validate_cart_addons, validate_order, order_valid_if_pending, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
Check-ins Check-ins
""""""""" """""""""
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: checkin_created :members: checkin_created
@@ -39,18 +41,21 @@ Frontend
.. automodule:: pretix.presale.signals .. automodule:: pretix.presale.signals
:no-index:
:members: order_info, order_info_top, order_meta_from_request, order_api_meta_from_request :members: order_info, order_info_top, order_meta_from_request, order_api_meta_from_request
Request flow Request flow
"""""""""""" """"""""""""
.. automodule:: pretix.presale.signals .. automodule:: pretix.presale.signals
:no-index:
:members: process_request, process_response :members: process_request, process_response
Vouchers Vouchers
"""""""" """"""""
.. automodule:: pretix.presale.signals .. automodule:: pretix.presale.signals
:no-index:
:members: voucher_redeem_info :members: voucher_redeem_info
Backend Backend
@@ -62,24 +67,28 @@ Backend
item_formsets, order_search_filter_q, order_search_forms item_formsets, order_search_filter_q, order_search_forms
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events, orderposition_blocked_display, customer_created, customer_signed_in
Vouchers Vouchers
"""""""" """"""""
.. automodule:: pretix.control.signals .. automodule:: pretix.control.signals
:no-index:
:members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
Dashboards Dashboards
"""""""""" """"""""""
.. automodule:: pretix.control.signals .. automodule:: pretix.control.signals
:no-index:
:members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
Ticket designs Ticket designs
"""""""""""""" """"""""""""""
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: layout_text_variables, layout_image_variables :members: layout_text_variables, layout_image_variables
.. automodule:: pretix.plugins.ticketoutputpdf.signals .. automodule:: pretix.plugins.ticketoutputpdf.signals
@@ -89,4 +98,5 @@ API
--- ---
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: validate_event_settings, api_event_settings_fields :members: validate_event_settings, api_event_settings_fields

View File

@@ -60,6 +60,7 @@ that we'll provide in this plugin:
Similar signals exist for other objects: Similar signals exist for other objects:
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: voucher_import_columns :members: voucher_import_columns

View File

@@ -84,8 +84,6 @@ convenient to you:
.. automethod:: _register_fonts .. automethod:: _register_fonts
.. automethod:: _register_event_fonts
.. automethod:: _on_first_page .. automethod:: _on_first_page
.. automethod:: _on_other_page .. automethod:: _on_other_page

View File

@@ -86,7 +86,10 @@ Signals
------- -------
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: register_text_placeholders :members: register_text_placeholders
.. automodule:: pretix.base.signals .. automodule:: pretix.base.signals
:no-index:
:members: register_mail_placeholders :members: register_mail_placeholders

View File

@@ -1,5 +1,5 @@
KulturPass KulturPass
========= ==========
.. note:: .. note::

View File

@@ -158,7 +158,7 @@ expects and - more importantly - supports.
for a sample configuration in an academic context. for a sample configuration in an academic context.
Note, that you can have multiple attributes with the same ``friendlyName`` Note, that you can have multiple attributes with the same ``friendlyName``
but different ``name``s. This is often used in systems, where the same but different ``name`` value. This is often used in systems, where the same
information (for example a persons name) is saved in different fields - information (for example a persons name) is saved in different fields -
for example because one institution is returning SAML 1.0 and other for example because one institution is returning SAML 1.0 and other
institutions are returning SAML 2.0 style attributes. Typically, this only institutions are returning SAML 2.0 style attributes. Typically, this only

View File

@@ -1118,13 +1118,12 @@ class ItemVariation(models.Model):
:param original_price: The item's "original" price. Will not be used for any calculations, will just be shown. :param original_price: The item's "original" price. Will not be used for any calculations, will just be shown.
:type original_price: decimal.Decimal :type original_price: decimal.Decimal
:param require_approval: If set to ``True``, orders containing this variation can only be processed and paid after :param require_approval: If set to ``True``, orders containing this variation can only be processed and paid after
approval by an administrator approval by an administrator
:type require_approval: bool :type require_approval: bool
:param all_sales_channels: A flag indicating that this variation is available on all channels and limit_sales_channels will be ignored. :param all_sales_channels: A flag indicating that this variation is available on all channels and limit_sales_channels will be ignored.
:type all_sales_channels: bool :type all_sales_channels: bool
:param limit_sales_channels: A list of sales channel identifiers, that this variation is available for sale on. :param limit_sales_channels: A list of sales channel identifiers, that this variation is available for sale on.
:type limit_sales_channels: list :type limit_sales_channels: list
""" """
item = models.ForeignKey( item = models.ForeignKey(
Item, Item,

View File

@@ -367,7 +367,7 @@ validate_cart_addons = EventPluginSignal()
Arguments: ``addons``, ``base_position``, ``iao`` Arguments: ``addons``, ``base_position``, ``iao``
This signal is sent when a user tries to select a combination of addons. In contrast to This signal is sent when a user tries to select a combination of addons. In contrast to
``validate_cart``, this is executed before the cart is actually modified. You are passed ``validate_cart``, this is executed before the cart is actually modified. You are passed
an argument ``addons`` containing a dict of ``(item, variation or None) → count`` tuples as well an argument ``addons`` containing a dict of ``(item, variation or None) → count`` tuples as well
as the ``ItemAddOn`` object as the argument ``iao`` and the base cart position as as the ``ItemAddOn`` object as the argument ``iao`` and the base cart position as
``base_position``. ``base_position``.