Smaller documentation updates

This commit is contained in:
Raphael Michel
2017-05-17 18:19:28 +02:00
parent 3f2bb3beae
commit ec9511c17a

View File

@@ -29,6 +29,9 @@ pretix/
static/ static/
Contains all static files (CSS, JavaScript, images) Contains all static files (CSS, JavaScript, images)
static/
Contains some pretix plugins that ship with pretix itself
tests/ tests/
This is the root directory for all test codes. It includes subdirectories ``base``, This is the root directory for all test codes. It includes subdirectories ``base``,
``control``, ``presale``, ``helpers`` and ``plugins`` to mirror the structure of the ``control``, ``presale``, ``helpers`` and ``plugins`` to mirror the structure of the
@@ -37,7 +40,8 @@ tests/
Language files Language files
-------------- --------------
The language files live in ``locale/*/LC_MESSAGES/``.
The language files live in ``pretix/locale/*/LC_MESSAGES/``.
Static files Static files
------------ ------------
@@ -49,27 +53,14 @@ We use libsass as a preprocessor for CSS. Our own sass code is built in the same
step as Bootstrap and FontAwesome, so their mixins etc. are fully available. step as Bootstrap and FontAwesome, so their mixins etc. are fully available.
pretix.control pretix.control
pretixcontrol has two main SCSS files, ``pretix/control/static/pretixcontrol/scss/main.scss`` and pretixcontrol has two main SCSS files, ``pretix/static/pretixcontrol/scss/main.scss`` and
``pretix/control/static/pretixcontrol/scss/auth.scss``, importing everything else. ``pretix/static/pretixcontrol/scss/auth.scss``, importing everything else.
pretix.presale pretix.presale
pretixpresale has one main SCSS files, ``pretix/control/static/pretix/presale/scss/main.scss``, pretixpresale has one main SCSS files, ``pretix/pretixpresale/scss/main.scss``,
importing everything else. importing everything else.
3rd-party assets 3rd-party assets
^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^
Bootstrap Most client-side 3rd-party assets are vendored in various subdirectories of ``pretix/static``.
Bootstrap lives vendored at ``static/bootstrap/``
Font Awesome
Font Awesome lives vendored at ``static/fontawesome/``
jQuery
jQuery lives as a single JavaScript file in ``static/jquery/js/``
jQuery plugin: Django formsets
Our own modified version of `django-formset-js`_ is available as an independent
django app and installed via ``pip``.
.. _django-formset-js: https://github.com/pretix/django-formset-js