From ec94de57de6afd34d0d8018d7a1f57a216288c99 Mon Sep 17 00:00:00 2001
From: github-actions
Date: Fri, 22 Nov 2024 07:01:13 +0000
Subject: [PATCH] Updated documentation
---
_sources/customization.rst.txt | 12 ++++++------
customization.html | 12 ++++++------
htmlcov/class_index.html | 4 ++--
htmlcov/function_index.html | 4 ++--
htmlcov/index.html | 4 ++--
htmlcov/manage_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_DateParser_py.html | 4 ++--
htmlcov/z_079cb04380c5d241___init___py.html | 4 ++--
htmlcov/z_079cb04380c5d241_authentication_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_autocomplete_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_fields_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_filters_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_helpers_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_normalize_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_rdf_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_settings_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_test_DateParser_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_test_helpers_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_test_normalize_py.html | 4 ++--
htmlcov/z_079cb04380c5d241_test_rdf_py.html | 4 ++--
htmlcov/z_0b6d599bfac90e15___init___py.html | 4 ++--
.../z_0b6d599bfac90e15_test_simple_history_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c___init___py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_api_views_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_apps_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_models_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_serializers_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_tables_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_urls_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_utils_py.html | 4 ++--
htmlcov/z_18f121dc3730a25c_views_py.html | 4 ++--
htmlcov/z_210622b261945b4b_core_py.html | 4 ++--
htmlcov/z_2117b3d262c5684b_urls_py.html | 4 ++--
htmlcov/z_2117b3d262c5684b_utils_py.html | 4 ++--
htmlcov/z_2117b3d262c5684b_views_py.html | 4 ++--
htmlcov/z_2c9c277fca33aa93___init___py.html | 4 ++--
htmlcov/z_2c9c277fca33aa93_urls_py.html | 4 ++--
htmlcov/z_2d258017742203c3_generic_py.html | 4 ++--
htmlcov/z_38054c303eea2897_history_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4___init___py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_apps_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_forms_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_models_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_querysets_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_settings_loaddata_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_settings_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_tables_py.html | 4 ++--
htmlcov/z_3eb2033f4386aef4_urls_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a___init___py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_admin_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_apps_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_filtersets_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_forms_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_models_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_serializers_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_signals_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_tables_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_urls_py.html | 4 ++--
htmlcov/z_49ff5da25a66209a_viewsets_py.html | 4 ++--
htmlcov/z_572d048ccdded887___init___py.html | 4 ++--
htmlcov/z_572d048ccdded887_abc_py.html | 4 ++--
htmlcov/z_572d048ccdded887_api_views_py.html | 4 ++--
htmlcov/z_572d048ccdded887_apps_py.html | 4 ++--
htmlcov/z_572d048ccdded887_autocomplete3_py.html | 4 ++--
htmlcov/z_572d048ccdded887_fields_py.html | 4 ++--
htmlcov/z_572d048ccdded887_filtersets_py.html | 4 ++--
htmlcov/z_572d048ccdded887_forms_py.html | 4 ++--
htmlcov/z_572d048ccdded887_models_py.html | 4 ++--
htmlcov/z_572d048ccdded887_serializers_py.html | 4 ++--
htmlcov/z_572d048ccdded887_signals_py.html | 4 ++--
htmlcov/z_572d048ccdded887_tables_py.html | 4 ++--
htmlcov/z_572d048ccdded887_urls_py.html | 4 ++--
htmlcov/z_572d048ccdded887_utils_py.html | 4 ++--
htmlcov/z_572d048ccdded887_views_py.html | 4 ++--
htmlcov/z_5d8b244af5c2277b_0001_initial_py.html | 4 ++--
...f5c2277b_0002_property_property_class_uri_py.html | 4 ++--
..._5d8b244af5c2277b_0003_auto_20230123_1715_py.html | 4 ++--
..._5d8b244af5c2277b_0004_auto_20230124_1201_py.html | 4 ++--
...perty_obj_class_alter_property_subj_class_py.html | 4 ++--
...z_5d8b244af5c2277b_0006_versiontemptriple_py.html | 4 ++--
...277b_0007_alter_versiontemptriple_options_py.html | 4 ++--
htmlcov/z_5d8b244af5c2277b___init___py.html | 4 ++--
htmlcov/z_73d20026d8cfd537___init___py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_admin_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_apps_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_models_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_signals_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_tables_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_urls_py.html | 4 ++--
htmlcov/z_73d20026d8cfd537_views_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d___init___py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_admin_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_apps_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_filters_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_filtersets_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_forms_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_models_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_signals_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_tables_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_urls_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_utils_py.html | 4 ++--
htmlcov/z_742a021fcfacff1d_views_py.html | 4 ++--
htmlcov/z_754a3a2495383e43_0001_initial_py.html | 4 ++--
...95383e43_0002_remove_tempentityclass_text_py.html | 4 ++--
...383e43_0003_remove_tempentityclass_source_py.html | 4 ++--
...a3a2495383e43_0004_delete_tempentityclass_py.html | 4 ++--
htmlcov/z_754a3a2495383e43___init___py.html | 4 ++--
htmlcov/z_75fef824206db77b_relations_py.html | 4 ++--
htmlcov/z_782cd176b95f1058_0001_initial_py.html | 4 ++--
...95f1058_0002_alter_skoscollection_options_py.html | 4 ++--
...koscollection_unique_name_parent_and_more_py.html | 4 ++--
htmlcov/z_782cd176b95f1058___init___py.html | 4 ++--
htmlcov/z_87b47be0c3172b83___init___py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_admin_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_apps_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_filtersets_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_forms_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_models_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_querysets_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_serializers_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_signals_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_tables_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_urls_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_utils_py.html | 4 ++--
htmlcov/z_87b47be0c3172b83_views_py.html | 4 ++--
htmlcov/z_917923bad02a23ec_0001_initial_py.html | 4 ++--
...2_iscousinof_ispartof_issiblingof_livesin_py.html | 4 ++--
..._0003_alter_versiongroup_options_and_more_py.html | 4 ++--
htmlcov/z_917923bad02a23ec___init___py.html | 4 ++--
htmlcov/z_9e462fdf71a95359___init___py.html | 4 ++--
htmlcov/z_9e462fdf71a95359_fields_py.html | 4 ++--
htmlcov/z_9e462fdf71a95359_widgets_py.html | 4 ++--
htmlcov/z_a87bbc0055e2906a___init___py.html | 4 ++--
htmlcov/z_a87bbc0055e2906a_tests_py.html | 4 ++--
htmlcov/z_b98ef7dc8a4f2930_mixins_py.html | 4 ++--
htmlcov/z_b98ef7dc8a4f2930_models_py.html | 4 ++--
htmlcov/z_b98ef7dc8a4f2930_urls_py.html | 4 ++--
htmlcov/z_b98ef7dc8a4f2930_views_py.html | 4 ++--
htmlcov/z_bacc1c03c9be4470_apis_relations_py.html | 4 ++--
htmlcov/z_c3a4d981b07ef925_sample_project_py.html | 4 ++--
htmlcov/z_d10b1e8419087c99_apis_entities_py.html | 4 ++--
htmlcov/z_d4c4f42115e675b2___init___py.html | 4 ++--
htmlcov/z_d4c4f42115e675b2_collections_py.html | 4 ++--
htmlcov/z_e42e1fb98877cc0c_0001_initial_py.html | 4 ++--
...0002_remove_texttype_collections_and_more_py.html | 4 ++--
...c_0003_delete_vocabnames_delete_vocabsuri_py.html | 4 ++--
...2e1fb98877cc0c_0004_delete_collectiontype_py.html | 4 ++--
...e1fb98877cc0c_0005_delete_vocabsbaseclass_py.html | 4 ++--
htmlcov/z_e42e1fb98877cc0c___init___py.html | 4 ++--
htmlcov/z_ef4d16bc632aabbd_0001_initial_py.html | 4 ++--
..._ef4d16bc632aabbd_0002_auto_20220201_1241_py.html | 4 ++--
..._ef4d16bc632aabbd_0003_auto_20220218_1530_py.html | 4 ++--
..._ef4d16bc632aabbd_0004_auto_20230310_0804_py.html | 4 ++--
...ef4d16bc632aabbd_0005_delete_uricandidate_py.html | 4 ++--
htmlcov/z_ef4d16bc632aabbd_0006_delete_text_py.html | 4 ++--
.../z_ef4d16bc632aabbd_0007_delete_source_py.html | 4 ++--
...bd_0008_alter_rootobject_self_contenttype_py.html | 4 ++--
...bd_0009_remove_collection_collection_type_py.html | 4 ++--
...10_rename_name_rootobject_deprecated_name_py.html | 4 ++--
...bbd_0011_alter_rootobject_deprecated_name_py.html | 4 ++--
...bd_0012_remove_rootobject_deprecated_name_py.html | 4 ++--
...z_ef4d16bc632aabbd_0013_delete_collection_py.html | 4 ++--
...ove_uri_domain_remove_uri_loaded_and_more_py.html | 4 ++--
htmlcov/z_ef4d16bc632aabbd___init___py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e___init___py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_abc_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_api_views_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_filterbackends_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_filtersets_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_generators_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_helpers_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_importers_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_renderers_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_routers_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_serializers_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_tables_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_urls_py.html | 4 ++--
htmlcov/z_ef777899a9cfc89e_views_py.html | 4 ++--
htmlcov/z_f58a2f3fa6848a17_0001_initial_py.html | 4 ++--
htmlcov/z_f58a2f3fa6848a17___init___py.html | 4 ++--
index.html | 2 +-
installation.html | 2 +-
searchindex.js | 2 +-
183 files changed, 371 insertions(+), 371 deletions(-)
diff --git a/_sources/customization.rst.txt b/_sources/customization.rst.txt
index 8b8a9bc9e..a088c8e66 100644
--- a/_sources/customization.rst.txt
+++ b/_sources/customization.rst.txt
@@ -19,10 +19,10 @@ In standard APIS those models are
The :py:mod:`apis_core.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/``
+``your_app.models`` module, you can use the generic views for it.
+``/apis/your_app.historicalperson/``
will be the URL for the list view of the historical model.
-``/apis/api/apis_ontology.historicalperson/`` for the API view.
+``/apis/api/your_app.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`.
@@ -40,7 +40,7 @@ of results on the right side.
The default filterset used is
:class:`apis_core.generic.filtersets.GenericFilterSet`. You can override the
filterset for you models by defining a custom filterset class in
-``you_app.filtersets``. The filterset has to be named ``FilterSet``,
+``your_app.filtersets``. The filterset has to be named ``FilterSet``,
so if you have a model ``Person`` in your app ``myproject``, the view looks for
the filterset ``myproject.filtersets.PersonFilterSet``. You can inherit from
:class:`apis_core.generic.filtersets.GenericFilterSet` and add your
@@ -64,7 +64,7 @@ pagination (which is the default).
The base queryset that is used in the listview, which is then filtered using
the django-filters filter, is ``model.objects.all()`` - but you can override
the queryset by creating a custom queryset for your model in
-``you_app.querysets``. The queryset function has to be named
+``your_app.querysets``. The queryset function has to be named
``ListViewQueryset``, so if you have a model ``Person`` in your app
``myproject``, the view looks for the queryset
``myproject.querysets.PersonListViewQueryset``.
@@ -83,7 +83,7 @@ Create and Update views
The create and update view use the form
:class:`apis_core.generic.forms.GenericModelForm` by default. You can override
-the form it uses by creating a custom form in ``you_app.forms``. The form class
+the form it uses by creating a custom form in ``your_app.forms``. The form class
has to be named ``Form``, so if you have a model ``Person`` in your
app ``myproject``, the view looks for the form class
``myproject.forms.PersonForm``.
diff --git a/customization.html b/customization.html
index 80437972b..008d63360 100644
--- a/customization.html
+++ b/customization.html
@@ -120,10 +120,10 @@
Customizationapis_core.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/
+your_app.models module, you can use the generic views for it.
+/apis/your_app.historicalperson/
will be the URL for the list view of the historical model.
-/apis/api/apis_ontology.historicalperson/ for the API view.
+/apis/api/your_app.historicalperson/ for the API view.
List viewsapis_core.generic.filtersets.GenericFilterSet. You can override the
filterset for you models by defining a custom filterset class in
-you_app.filtersets. The filterset has to be named <Modelname>FilterSet,
+your_app.filtersets. The filterset has to be named <Modelname>FilterSet,
so if you have a model Person in your app myproject, the view looks for
the filterset myproject.filtersets.PersonFilterSet. You can inherit from
apis_core.generic.filtersets.GenericFilterSet and add your
@@ -154,7 +154,7 @@
The create and update view use the form
apis_core.generic.forms.GenericModelForm by default. You can override
-the form it uses by creating a custom form in you_app.forms. The form class
+the form it uses by creating a custom form in your_app.forms. The form class
has to be named <Modelname>Form, so if you have a model Person in your
app myproject, the view looks for the form class
myproject.forms.PersonForm.