diff --git a/biscuit/core/models.py b/biscuit/core/models.py index e4e06d21e173f47c61245c99fe04ec202f7e267f..f791850d88efa9d0274cc8fced0ff8b268b0e9b6 100644 --- a/biscuit/core/models.py +++ b/biscuit/core/models.py @@ -14,6 +14,10 @@ class School(models.Model): class Person(SchoolRelated): + """ A model describing any person related to a school, including, but not + limited to, students, teachers and guardians (parents). + """ + class Meta: unique_together = [['school', 'short_name'], ['school', 'import_ref']] diff --git a/docs/index.rst b/docs/index.rst index d240949b87f95b70fb44fd4b7865c1a1cfce2f26..c21b7403108ebca2deaad8d51b37cbb4f33037b5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,7 @@ Welcome to BiscuIT's documentation! :caption: Contents: dev/00_index + ref/00_index Indices and tables diff --git a/docs/ref/00_index.rst b/docs/ref/00_index.rst new file mode 100644 index 0000000000000000000000000000000000000000..1f1524f16bf49c6a0f43cd0dcc4e135bebdd8413 --- /dev/null +++ b/docs/ref/00_index.rst @@ -0,0 +1,7 @@ +API and models reference +======================== + +.. toctree:: + :glob: + + core/* diff --git a/docs/ref/core/01_models.rst b/docs/ref/core/01_models.rst new file mode 100644 index 0000000000000000000000000000000000000000..bfec932dda1e48a939a707eea20470d34061688b --- /dev/null +++ b/docs/ref/core/01_models.rst @@ -0,0 +1,5 @@ +Core data models +================ + +.. automodule:: biscuit.core.models + :members: