Split documentation into one page per object

trompamusic · Feb 19, 2021 · 1144b0e · 1144b0e
1 parent 5d544f2
commit 1144b0e
Show file tree

Hide file tree

Showing 17 changed files with 89 additions and 34 deletions.
diff --git a/docs/digitaldocument.rst b/docs/digitaldocument.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,7 +18,7 @@ For information about the TROMPA schema, see :ref:`schema:TROMPA Schema`
    :maxdepth: 2
    :caption: Contents:
 
-   mutations
+   mutations/index
    queries
    algorithms
    TROMPA Schema <schema>

diff --git a/docs/mutations.rst b/docs/mutations.rst
diff --git a/docs/mutations/audioobject.rst b/docs/mutations/audioobject.rst
@@ -0,0 +1,5 @@
+AudioObject
+-----------
+
+.. automodule:: trompace.mutations.audioobject
+   :members:
diff --git a/docs/mutations/controlaction.rst b/docs/mutations/controlaction.rst
@@ -0,0 +1,5 @@
+ControlAction
+-------------
+
+.. automodule:: trompace.mutations.controlaction
+   :members:
diff --git a/docs/mutations/definedterm.rst b/docs/mutations/definedterm.rst
@@ -0,0 +1,5 @@
+DefinedTerm
+-----------
+
+.. automodule:: trompace.mutations.definedterm
+   :members:
diff --git a/docs/mutations/digitaldocument.rst b/docs/mutations/digitaldocument.rst
@@ -0,0 +1,5 @@
+DigitalDocument
+---------------
+
+.. automodule:: trompace.mutations.digitaldocument
+   :members:
diff --git a/docs/mutations/entrypoint.rst b/docs/mutations/entrypoint.rst
@@ -0,0 +1,5 @@
+EntryPoint
+----------
+
+.. automodule:: trompace.mutations.entrypoint
+   :members:
diff --git a/docs/mutations/index.rst b/docs/mutations/index.rst
@@ -0,0 +1,27 @@
+Mutations
+=========
+
+Mutations are queries used to create or update data in the CE.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   audioobject
+   controlaction
+   definedterm
+   digitaldocument
+   entrypoint
+   itemlist
+   mediaobject
+   musiccomposition
+   person
+   place
+   property
+   rating
+
+
+
+
+
+
diff --git a/docs/mutations/itemlist.rst b/docs/mutations/itemlist.rst
@@ -0,0 +1,5 @@
+ItemList
+--------
+
+.. automodule:: trompace.mutations.itemlist
+   :members:
diff --git a/docs/mutations/mediaobject.rst b/docs/mutations/mediaobject.rst
@@ -0,0 +1,5 @@
+MediaObject
+-----------
+
+.. automodule:: trompace.mutations.mediaobject
+   :members:
diff --git a/docs/mutations/musiccomposition.rst b/docs/mutations/musiccomposition.rst
@@ -0,0 +1,5 @@
+MusicComposition
+----------------
+
+.. automodule:: trompace.mutations.musiccomposition
+   :members:
diff --git a/docs/person.rst → docs/mutations/person.rst b/docs/person.rst → docs/mutations/person.rst
@@ -32,4 +32,9 @@ We recommend that the following fields are set:
 Relations
 ---------
 
-exactMatch: Use :meth:`trompace.mutations.person.mutation_person_add_exact_match_person`
+exactMatch: Use :meth:`trompace.mutations.person.mutation_person_add_exact_match_person`
+
+
+
+.. automodule:: trompace.mutations.person
+   :members:
diff --git a/docs/mutations/place.rst b/docs/mutations/place.rst
@@ -0,0 +1,5 @@
+Place
+-----
+
+.. automodule:: trompace.mutations.place
+   :members:
diff --git a/docs/mutations/property.rst b/docs/mutations/property.rst
@@ -0,0 +1,5 @@
+Property
+--------
+
+.. automodule:: trompace.mutations.property
+   :members:
diff --git a/docs/mutations/rating.rst b/docs/mutations/rating.rst
@@ -0,0 +1,5 @@
+Rating
+------
+
+.. automodule:: trompace.mutations.rating
+   :members:
diff --git a/docs/schema.rst b/docs/schema.rst
@@ -5,5 +5,3 @@ TROMPA Schema
    :maxdepth: 2
    :caption: TROMPA schema entities:
 
-   DigitalDocument <digitaldocument>
-   Person <person>