Add sphinx based docs

This commit is contained in:
Swen Kooij
2019-10-20 17:11:33 +03:00
parent 7bf0311306
commit cdf1831d35
17 changed files with 839 additions and 0 deletions

View File

@@ -0,0 +1,19 @@
Django Admin
------------
To display ``LocalizedFields`` as a tab bar in Django Admin; inherit your admin model class from ``LocalizedFieldsAdminMixin``:
.. code-block:: python
from django.contrib import admin
from myapp.models import MyLocalizedModel
from localized_fields.admin import LocalizedFieldsAdminMixin
class MyLocalizedModelAdmin(LocalizedFieldsAdminMixin, admin.ModelAdmin):
"""Any admin options you need go here"""
admin.site.register(MyLocalizedModel, MyLocalizedModelAdmin)
.. image:: _static/django_admin_widget.png