doc: adds apis_history to doc

acdh-oeaw · Mar 21, 2024 · 5b0f8f3 · 5b0f8f3
1 parent 3c8b91a
commit 5b0f8f3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/customization.rst b/docs/source/customization.rst
@@ -13,6 +13,14 @@ In standard APIS those models are
 * :class:`apis_core.collections.models.SkosCollection`
 * :class:`apis_core.collections.models.SkosCollectionContentObject`
 
+The :py:mod:`apis_core.apis_history` module also uses the generic views for
+its models. This means that you can use the generic views for the historical 
+models of your own ontology. E.g. if you have a model ``Person`` in your 
+`apis_ontology.models` module, you can use the generic views for it. 
+`/apis/apis_ontology.historicalperson/</apis/apis_ontology.historicalperson/>`_ 
+will be the URL for the list view of the historical model. 
+`/apis/api/apis_ontology.historicalperson/</apis/api/apis_ontology.historicalperson/>`_ for the API view.
+
 If you want to use the generic app for your own model, simple make your model
 inherit from :class:`apis_core.generic.abc.GenericModel`.
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -16,6 +16,7 @@ Welcome to APIS's documentation!
    settings
    customization
    user_documentation
+   apis_history
    data_model
    glossary
    development