weblate/docs/contributing/internals.rst
Michal Čihař 9b23f174e5 Add-ons: Fix spelling
Avoid using "addon".
2021-04-20 11:10:22 +02:00

106 lines
1.9 KiB
ReStructuredText

.. _internals:
Weblate internals
=================
.. note::
This chapter will give you basic overview of Weblate internals.
Weblate derives most of its code structure from, and is based on `Django`_.
Directory structure
-------------------
Quick overview of directory structure of Weblate main repository:
``docs``
Source code for this documentation, which can be built using `Sphinx <https://www.sphinx-doc.org/>`_.
``dev-docker``
Docker code to run development server, see :ref:`dev-docker`.
``weblate``
Source code of Weblate as a `Django <https://www.djangoproject.com/>`_ application, see :ref:`internals`.
``weblate/static``
Client files (CSS, Javascript and images), see :doc:`frontend`.
Modules
-------
Weblate consists of several Django applications (some optional, see
:doc:`/admin/optionals`):
``accounts``
User account, profiles and notifications.
``addons``
Add-ons to tweak Weblate behavior, see :ref:`addons`.
``api``
API based on `Django REST framework`_.
``auth``
Authentication and permissions.
``billing``
The optional :ref:`billing` module.
``checks``
Translation string :ref:`checks` module.
``fonts``
Font rendering checks module.
``formats``
File format abstraction layer based on translate-toolkit.
``gitexport``
The optional :ref:`git-exporter` module.
``lang``
Module defining language and plural models.
``legal``
The optional :ref:`legal` module.
``machinery``
Integration of machine translation services.
``memory``
Built-in translation memory, see :ref:`translation-memory`.
``screenshots``
Screenshots management and OCR module.
``trans``
Main module handling translations.
``utils``
Various helper utilities.
``vcs``
Version control system abstraction.
``wladmin``
Django admin interface customization.
.. _Django: https://www.djangoproject.com/
.. _Django REST framework: https://www.django-rest-framework.org/