django-modeltranslation/docs/modeltranslation
2024-06-20 20:11:24 +03:00
..
_static Added a empty _static directory to docs (alongside a useless .gitignore to allow to commit it with git). Suppresses a warning generated by sphinx. 2012-11-13 14:46:50 +01:00
admin.rst fix: Removed protocol from admin javascript links. 2024-05-27 10:08:23 +03:00
authors.rst Major refactoring of the documentation. 2012-10-17 15:02:22 +02:00
caveats.rst feat: Add support for ManyToManyFields 🧑‍🤝‍🧑 (#668) 2023-01-27 15:05:18 +02:00
changelog.rst Fix changelog import (#610) 2021-09-09 21:11:02 +03:00
commands.rst docs: add optional flags for update_translation_fields command 2021-03-10 13:50:40 -06:00
conf.py style: Reformat files (use double quotes) 2023-11-25 13:48:57 +02:00
contribute.rst chore: Switch to ruff format 2023-11-25 13:48:57 +02:00
forms.rst General documentation improvements. 2014-07-20 01:58:00 +02:00
index.rst Add docs about empty_values (close #211). 2013-11-09 14:28:38 +01:00
installation.rst Updated testing instructions in contribution and installation guides and bumped version number to 0.18.10 in pyproject.toml. 2023-06-02 14:07:15 +02:00
make.bat Converted documentation to shpinx and added an initial setup (work-in-progress). 2012-10-17 11:18:36 +02:00
Makefile Converted documentation to shpinx and added an initial setup (work-in-progress). 2012-10-17 11:18:36 +02:00
readme.rst Major refactoring of the documentation. 2012-10-17 15:02:22 +02:00
registration.rst chore: Fix versionadded 2024-06-20 20:11:24 +03:00
related_projects.rst docs: Fix a few typos (#651) 2022-09-03 21:56:06 +03:00
usage.rst fix(docs): Fixed legacy python 2 print statements 2021-04-29 15:40:00 +03:00

================
Modeltranslation
================

.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg
   :target: https://stand-with-ukraine.pp.ua
   :alt: Stand With Ukraine

-----

.. image:: http://img.shields.io/coveralls/deschler/django-modeltranslation.svg?style=flat-square
    :target: https://coveralls.io/r/deschler/django-modeltranslation

.. image:: https://img.shields.io/pypi/v/django-modeltranslation.svg?style=flat-square
    :target: https://pypi.python.org/pypi/django-modeltranslation/
    :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/pyversions/django-modeltranslation.svg?style=flat-square
    :target: https://pypi.python.org/pypi/django-modeltranslation/
    :alt: Supported Python versions

.. image:: https://img.shields.io/gitter/room/django-modeltranslation/community?color=4DB798&style=flat-square
    :alt: Join the chat at https://gitter.im/django-modeltranslation/community
    :target: https://gitter.im/django-modeltranslation/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge


The modeltranslation application is used to translate dynamic content of
existing Django models to an arbitrary number of languages without having to
change the original model classes. It uses a registration approach (comparable
to Django's admin app) to be able to add translations to existing or new
projects and is fully integrated into the Django admin backend.

The advantage of a registration approach is the ability to add translations to
models on a per-app basis. You can use the same app in different projects,
may they use translations or not, and you never have to touch the original
model class.

Features
========

- Add translations without changing existing models or views
- Translation fields are stored in the same table (no expensive joins)
- Supports inherited models (abstract and multi-table inheritance)
- Handle more than just text fields
- Django admin integration
- Flexible fallbacks, auto-population and more!

For the latest documentation, visit https://django-modeltranslation.readthedocs.io/en/latest/.