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

82
docs/source/saving.rst Normal file
View File

@@ -0,0 +1,82 @@
Saving localized content
========================
.. note::
All examples below assume a model declared like this:
.. code-block:: python
from localized_fields.models import LocalizedModel
from localized_fields.fields import LocalizedField
class MyModel(LocalizedModel):
title = LocalizedField()
Individual assignment
*********************
.. code-block:: python
obj = MyModel()
obj.title.en = 'Hello'
obj.title.nl = 'Hallo'
obj.save()
Individual dynamic assignment
*****************************
.. code-block:: python
obj = MyModel()
obj.title.set('en', 'Hello')
obj.title.set('nl', 'Hallo')
obj.save()
Multiple assignment
*******************
.. code-block:: python
obj = MyModel()
obj.title = dict(en='Hello', nl='Hallo')
obj.save()
obj = MyModel(title=dict(en='Hello', nl='Hallo'))
obj.save()
obj = MyModel.objects.create(title=dict(en='Hello', nl='Hallo'))
Default language assignment
***************************
.. code-block:: python
obj = MyModel()
obj.title = 'Hello' # assumes value is in default language
obj.save()
obj = MyModel(title='Hello') # assumes value is in default language
obj.save()
obj = MyModel.objects.create(title='title') # assumes value is in default language
Array assignment
****************
.. code-block:: python
obj = MyModel()
obj.title = ['Hello', 'Hallo'] # order according to LANGUAGES
obj.save()
obj = MyModel(title=['Hello', 'Hallo']) # order according to LANGUAGES
obj.save()
obj = MyModel.objects.create(title=['Hello', 'Hallo']) # order according to LANGUAGES