Implement automatic spell-check for docs (#688)

* [WIP] Implement automatic spell-check for docs fixes #663 The only thing unclear to me so far is how the output of `make spelling` should be checked - is there a possibility to check for a file (i.e. `_build/spelling/output.txt`) to be empty, and report a failed build otherwise? * fix typo in requirements.txt * add enchant library * travis should report errors, order spelling wordlist * change travis.yml to easier troubleshoot build issues * fixed more typos, added more words * add more words, fix more typos * added more words * added more words * revert changes to .travis.yml
2026-08-28 13:34:40 +00:00 · 2017-12-11 11:41:59 +01:00
parent fb5fa57fd6
commit 9ab39904e8
41 changed files with 217 additions and 54 deletions
@@ -175,3 +175,9 @@ pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo
+	@echo "Spelling check finished, look at the results in " \
+		  "$(BUILDDIR)/spelling/output.txt."
@@ -2,6 +2,8 @@

 .. _`config`:

+.. spelling:: Galera
+
 Configuration file
 ==================

@@ -45,7 +47,7 @@ Example::

 ``datadir``
    The local path to a data directory that will be used for storing user uploads and similar
-    data. Defaults to thea value of the environment variable ``DATA_DIR`` or ``data``.
+    data. Defaults to the value of the environment variable ``DATA_DIR`` or ``data``.

 ``plugins_default``
    A comma-separated list of plugins that are enabled by default for all new events.
@@ -1,5 +1,7 @@
 .. highlight:: ini

+.. spelling:: SQL
+
 General remarks
 ===============

@@ -165,7 +165,7 @@ Endpoints
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(id)/

   Update a check-in list. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
-   the resource, other fields will be resetted to default. With ``PATCH``, you only need to provide the fields that you
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
   want to change.

   You can change all fields of the resource except the ``id`` field and the ``checkin_count`` and ``position_count``
@@ -221,5 +221,5 @@ Endpoints
   :statuscode 200: no error
   :statuscode 401: Authentication failure
   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
-   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting vor a few
+   :statuscode 409: The file is not yet ready and will now be prepared. Retry the request after waiting for a few
                    seconds.
@@ -70,7 +70,7 @@ addons                                list of objects            Definition of a
 ├ addon_category                      integer                    Internal ID of the item category the add-on can be
                                                                 chosen from.
 ├ min_count                           integer                    The minimal number of add-ons that need to be chosen.
-├ max_count                           integer                    The maxima number of add-ons that can be chosen.
+├ max_count                           integer                    The maximal number of add-ons that can be chosen.
 └ position                            integer                    An integer, used for sorting
 ===================================== ========================== =======================================================

@@ -79,7 +79,7 @@ downloads                             list of objects            List of ticket

   The attributes ``invoice_address.vat_id_validated`` and ``invoice_address.is_business`` have been added.
   The attributes ``order.payment_fee``, ``order.payment_fee_tax_rate`` and ``order.payment_fee_tax_value`` have been
-   deprecated in favour of the new ``fees`` attribute but will still be served and removed in 1.9.
+   deprecated in favor of the new ``fees`` attribute but will still be served and removed in 1.9.

 .. versionchanged:: 1.9

@@ -342,7 +342,7 @@ Order endpoints

   Download tickets for an order, identified by its order code. Depending on the chosen output, the response might
   be a ZIP file, PDF file or something else. The order details response contains a list of output options for this
-   partictular order.
+   particular order.

   Tickets can be only downloaded if the order is paid and if ticket downloads are active. Note that in some cases the
   ticket file might not yet have been created. In that case, you will receive a status code :http:statuscode:`409` and
@@ -158,7 +158,7 @@ Endpoints
 .. http:patch:: /api/v1/organizers/(organizer)/events/(event)/quotas/(id)/

   Update a quota. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
-   the resource, other fields will be resetted to default. With ``PATCH``, you only need to provide the fields that you
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
   want to change.

   You can change all fields of the resource except the ``id`` field.
@@ -45,6 +45,7 @@ extensions = [
    'sphinx.ext.coverage',
    'sphinxcontrib.httpdomain',
    'sphinxcontrib.images',
+    'sphinxcontrib.spelling',
 ]

 # Add any paths that contain templates here, relative to this directory.
@@ -290,3 +291,18 @@ texinfo_documents = [
 images_config = {
    'default_image_width': '250px'
 }
+
+# -- Options for Spelling output ------------------------------------------
+
+# String specifying the language, as understood by PyEnchant and enchant.
+# Defaults to en_US for US English.
+spelling_lang = 'en_US'
+
+# 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'
+
+# Boolean controlling whether suggestions for misspelled words are printed.
+# Defaults to False.
+spelling_show_suggestions=True
@@ -25,7 +25,7 @@ If you want to add a custom view to the control area of an event, just register
            views.admin_view, name='backend'),
    ]

-It is required that your URL paramaters are called ``organizer`` and ``event``. If you want to
+It is required that your URL parameters are called ``organizer`` and ``event``. If you want to
 install a view on organizer level, you can leave out the ``event``.

 You can then implement the view as you would normally do. Our middleware will automatically
@@ -19,7 +19,7 @@ To actually log an action, you can just call the ``log_action`` method on your o
   order.log_action('pretix.event.order.canceled', user=user, data={})

 The positional ``action`` argument should represent the type of action and should be globally unique, we
-recomment do prefix it with your packagename, e.g. ``paypal.payment.rejected``. The ``user`` argument is
+recommend to prefix it with your package name, e.g. ``paypal.payment.rejected``. The ``user`` argument is
 optional and may contain the user who performed the action. The optional ``data`` argument can contain
 additional information about this action.

@@ -1,6 +1,8 @@
 .. highlight:: python
   :linenothreshold: 5

+.. spelling:: answ contrib
+
 Data model
 ==========

@@ -35,7 +35,7 @@ Forms
 -----

 Hierarkey also provides a base class for forms that allow the modification of settings. pretix contains a
-subclass that also adds suport for internationalized fields:
+subclass that also adds support for internationalized fields:

 .. autoclass:: pretix.base.forms.SettingsForm

@@ -65,4 +65,4 @@ Plugins can add custom hardcoded defaults in the following way::
 Make sure that you include this code in a module that is imported at app loading time.

 .. _django-hierarkey: https://github.com/raphaelm/django-hierarkey
-.. _documentation: https://django-hierarkey.readthedocs.io/en/latest/
+.. _documentation: https://django-hierarkey.readthedocs.io/en/latest/
@@ -67,7 +67,7 @@ available as ``plugins:sendmail:send``.
 Generating a URL for the frontend is a complicated task, because you need to know whether the event's
 organizer uses a custom URL or not and then generate the URL with a different domain and different
 arguments based on this information. pretix provides some helpers to make this easier. The first helper
-is a python method that emulates a behaviour similar to ``reverse``:
+is a python method that emulates a behavior similar to ``reverse``:

 .. autofunction:: pretix.multidomain.urlreverse.eventreverse

@@ -82,5 +82,5 @@ Implementation details
 ----------------------

 There are some other caveats when using a design like this, e.g. you have to care about cookie domains
-and referer verification yourself. If you want to see how we built this, look into the ``pretix/multidomain/``
+and referrer verification yourself. If you want to see how we built this, look into the ``pretix/multidomain/``
 sub-tree.
@@ -106,7 +106,7 @@ Execute the following commands to check for code style errors::
    isort -c -rc .
    python manage.py check

-Execute the following command to run pretix' test suite (might take a coumple of minutes)::
+Execute the following command to run pretix' test suite (might take a couple of minutes)::

    py.test

@@ -122,7 +122,7 @@ for example::
    flake8 . || exit 1
    isort -q -rc -c . || exit 1

-This keeps you from accidentally creating commits violating the sdtyle guide.
+This keeps you from accidentally creating commits violating the style guide.

 Working with mails
 ^^^^^^^^^^^^^^^^^^
@@ -1,3 +1,6 @@
+.. spelling::
+   Analytics
+
 List of plugins
 ===============

@@ -3,3 +3,5 @@ sphinx
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images
+sphinxcontrib-spelling
+pyenchant
@@ -0,0 +1,118 @@
+addon
+addons
+api
+auth
+autobuild
+backend
+backends
+banktransfer
+boolean
+booleans
+cancelled
+casted
+checkbox
+checkin
+checkins
+checksum
+config
+contenttypes
+contextmanager
+cron
+cronjob
+debian
+deduplication
+discoverable
+django
+dockerfile
+durations
+eu
+filename
+filesystem
+fontawesome
+frontend
+frontpage
+gettext
+gunicorn
+hardcoded
+invalidations
+iterable
+libsass
+linters
+memcached
+metadata
+middleware
+mixin
+mixins
+multi
+multidomain
+namespace
+namespaced
+namespaces
+namespacing
+natively
+nginx
+ons
+optimizations
+param
+percental
+positionid
+pre
+prepend
+prepended
+prepending
+preprocessor
+presale
+pretix
+pretixdroid
+pretixpresale
+prometheus
+proxied
+proxying
+queryset
+redemptions
+redis
+refactored
+regex
+renderer
+renderers
+reportlab
+screenshot
+serializers
+serializers
+sexualized
+startup
+stdout
+stylesheet
+subdirectories
+subdirectory
+subdomain
+subdomains
+subevent
+subevents
+submodule
+subpath
+systemd
+testutils
+timestamp
+un
+unconfigured
+unix
+unprefixed
+untrusted
+username
+url
+viewset
+viewsets
+webhook
+webhooks
+webserver
+webservice
+workflow
+zipcode
+Datetime
+Embeddable
+Hierarkey
+OAuth
+SSL
+Uptime
+Yay
@@ -30,13 +30,13 @@ available products, quotas, prices and some meta information, but most settings
 We recommend to use this feature only if you really know that you need it and if you really run a lot of events, not if
 you run e.g. a yearly conference. You can read more on this feature :ref:`here <subevents>`.

-Once you set these values, you can procede to the next step:
+Once you set these values, you can proceed to the next step:

 .. thumbnail:: ../../screens/event/create_step2.png
   :align: center
   :class: screenshot

-In this step, you will be asked more detailled questions about your event. In particular, you can fill in the
+In this step, you will be asked more detailed questions about your event. In particular, you can fill in the
 following fields:

 Name
@@ -14,7 +14,7 @@ Logo image
    This logo will be shown as a banner above your shop. If you set it, the event name and date will no longer be
    displayed by the shop, so we suggest to include them in the image yourself. The maximal height of the image is
    120 pixels and if you want to use the full width, make your image 1140 pixels wide. If the user's screen is
-    smaller, the logo will be scaled down automatically, so it should still be legigible at smaller sizes.
+    smaller, the logo will be scaled down automatically, so it should still be legible at smaller sizes.

 Frontpage text
    This text will be shown on the front page of your ticket shop, above the list of products. You can use it to explain
@@ -39,4 +39,4 @@ Font
    Choose one of multiple fonts to use for your web shop.

 .. note:: Both the color and font settings can take a few seconds up to a few minutes before they become active on your
-          shop.
+          shop.
@@ -103,7 +103,7 @@ End of presale

 Quotas
  As for all events, no tickets will be available unless there is a quota created for them that specifies the number
-  of tickets available. You can create multiple quotas that are assinged to this date directly from this interface.
+  of tickets available. You can create multiple quotas that are assigned to this date directly from this interface.

 Item prices
  This is a table of all products configured for your shop. If you want, you can enter a new price for each one of them
@@ -18,7 +18,7 @@ your event, go to the respective section in your event's settings:
   :class: screenshot

 On this page, you can create, edit and delete your tax rules. Clicking on the name of a tax rule will take you to its
-detailled settings:
+detailed settings:

 .. thumbnail:: ../../screens/event/tax_detail.png
   :align: center
@@ -67,7 +67,7 @@ SSL
 ---

 Since buying a ticket normally involves entering sensitive data, we strongly suggest that you use SSL/HTTPS for the page
-that includes the widget. Initiatives like `Let's Encrypt`_ allow you to obtain a SSL certificat free of charge.
+that includes the widget. Initiatives like `Let's Encrypt`_ allow you to obtain a SSL certificate free of charge.

 All data transferred to pretix will be made over SSL, even if using the widget on a non-SSL site. However, without
 using SSL for your site, a man-in-the-middle attacker could potentially alter the widget in dangerous ways. Moreover,
@@ -75,7 +75,7 @@ using SSL is becoming standard practice and your customers might want expect see
 granted to SSL-enabled web pages.

 By default, the checkout process will open in a new tab in your customer's browsers if you don't use SSL for your
-website. If you confident to have a good reason for not using SSL, you can override this behaviour with the
+website. If you confident to have a good reason for not using SSL, you can override this behavior with the
 ``skip-ssl-check`` attribute::

   <pretix-widget event="https://pretix.eu/demo/democon/" skip-ssl-check></pretix-widget>
@@ -9,7 +9,7 @@ There are multiple ways to do this.
 First, you could just create some orders in your real shop and cancel/refund them later. If you don't want to process
 real payments for the tests, you can either use a "manual" payment method like bank transfer and just mark the orders
 as paid with the button in the backend, or if you want to use e.g. Stripe, you can configure pretix to use your keys
-for the Stripe test sytem and use their test credit cars. Read our :ref:`Stripe documentation <stripe>` for more
+for the Stripe test system and use their test credit cars. Read our :ref:`Stripe documentation <stripe>` for more
 information.

 Second, you could create a separate event, just for testing. In the last step of the :ref:`event creation process <event_create>`,
@@ -48,4 +48,4 @@ If you created a product and it doesn't show up, please follow the following ste
   variation is contained in a quota. If your event is an event series, make sure that the product is contained in a
   quota that is assigned to the series date that you access the shop for.
 6. If the sale period has not started yet or is already over, check the "Show items outside presale period" setting of
-   your event.
+   your event.
@@ -163,4 +163,4 @@ All other elements and attributes will be stripped during parsing.


 .. _Markdown: https://en.wikipedia.org/wiki/Markdown
-.. _Wikipedia: https://en.wikipedia.org
+.. _Wikipedia: https://en.wikipedia.org
@@ -47,11 +47,11 @@ Permissions separate into two areas:
   * Can change product settings – This permission allows to create and modify products and objects that are closely
     related to products, such as product categories, quotas, and questions.

-   * Can view orders – This permission allows viewing the list of orders and allindividual order details, but not
+   * Can view orders – This permission allows viewing the list of orders and all individual order details, but not
     changing anything about it. This also includes the various exports offered.

   * Can change orders – This permission allows all actions that involve changing an order, such as changing the products
-     in an order, marking an order as paid or refunden, importing banking data, etc. This only works properly if the
+     in an order, marking an order as paid or refunded, importing banking data, etc. This only works properly if the
     same users also have the "Can view orders" permission.

   * Can view vouchers – This permission allows viewing the list of vouchers including the voucher codes themselves and
@@ -60,4 +60,4 @@ same 5 %, such that for a ticket with a list price of 100 € you will get your
    ===================================================== =============

    Due to the various rounding steps performed by pretix and by the payment provider, the end total on
-    your bank account might stil vary by one cent.
+    your bank account might still vary by one cent.
@@ -2,7 +2,7 @@ Payment method overview
 =======================

 pretix allows you to accept payments using a variety of payment methods to fit the needs of very different events.
-This page gives you a short overview over them and links to more detailled descriptions in some cases.
+This page gives you a short overview over them and links to more detailed descriptions in some cases.

 Payment methods are built as pretix plugins. For this reason, you might first need to enable a certain plugin at
 "Settings" → "Plugins" in your event settings. Then, you can configure them in detail at "Settings" -> "Payment".
@@ -13,5 +13,4 @@ on this page as well as for additional ones.
 To get an overview of the officially supported payment methods and their pros and cons, head to the `pretix website`_.
 On these pages, you get more information on how to configure :ref:`stripe`, :ref:`paypal`, and :ref:`banktransfer`.

-
-.. _pretix website: https://pretix.eu/about/en/payments
+.. _pretix website: https://pretix.eu/about/en/payments
@@ -11,7 +11,7 @@ of the page shows a number of general settings that affect all payment methods:
 In particular, these are:

 Payment term in days
-  If a order has been created, it is supposed to be paid within this number of days. Of course, some payment mehtods
+  If a order has been created, it is supposed to be paid within this number of days. Of course, some payment methods
  (like credit card) succeed immediately in most cases, but others don't (like bank transfer) and even credit card
  payments might fail and you might want to give the customer a chance to try another credit card before losing their
  ticket. Therefore, we recommend setting a few days here. If you are accepting bank transfers, we wouldn't recommend
@@ -19,7 +19,7 @@ Payment term in days

 Last date of payments
  There is probably no use for payments received after your event, so you can set a date that the payment deadline of
-  a new order will never exceed. This has precendence over the number of days configured above, so if I create an order
+  a new order will never exceed. This has precedence over the number of days configured above, so if I create an order
  two days before the configured last date of payments, my payment term will only be two days, not ten. If you have
  payment methods that always require some time (like bank transfer), you will later be able to selectively disable them
  once the event comes closer.