django-modeltranslation/docs/modeltranslation
Serhii Tereshchenko 6b4bb733d9
fix: Store version as plain text file to simplify bumping (#636)
BREAKING CHANGE: Replaced `VERSION` in tuple format by `__version__` as a string
2022-05-14 11:11:07 +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 use get_fields hook 2019-05-29 12:16:36 +02:00
authors.rst Major refactoring of the documentation. 2012-10-17 15:02:22 +02:00
caveats.rst Add a caveat for django-rest-framework 2017-09-21 23:51:47 +03: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 fix: Store version as plain text file to simplify bumping (#636) 2022-05-14 11:11:07 +03:00
contribute.rst ci: Use github actions for CI 2021-09-18 10:09:50 +03: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 chore: Add python 3.9 to supported version list 2021-04-15 21:52:11 +03: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 docs: Fix typo 2021-07-07 22:54:59 +03:00
related_projects.rst Consistent capitalization of titles in docs. 2012-10-22 11:57:52 +02:00
usage.rst fix(docs): Fixed legacy python 2 print statements 2021-04-29 15:40:00 +03:00

==============
War in Ukraine
==============

On February 24th, 2022, Russia invaded Ukraine. I'm sole maintainer of this project
staying in safe place, but i don't know how long it would be safe.

Russian military shelling our cities, targeting civilian population.

Help Ukraine:

- https://supportukrainenow.org/

Talk to your politics, talk to your friends. Help us close the sky over Ukraine.

----------------

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

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.


.. 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


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!


Project Home
------------
https://github.com/deschler/django-modeltranslation

Documentation
-------------
https://django-modeltranslation.readthedocs.org/en/latest

Mailing List
------------
http://groups.google.com/group/django-modeltranslation