diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f339d80..51e86fd 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -64,3 +64,9 @@ repos: pass_filenames: false types: [python] stages: [pre-push] + - id: doc_build_verify + name: verify that docs could be build + entry: inv docs.build + language: system + pass_filenames: false + stages: [pre-push] diff --git a/HISTORY.rst b/HISTORY.rst index d0496a5..8f358e2 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -6,7 +6,7 @@ UNRELEASED ------------------ * Add explicit `created_by` argument to `CeleryResourceMixin` and pass it in -`ExportJobSerializer` validation + `ExportJobSerializer` validation 1.3.1 (2025-01-13) ------------------ @@ -21,8 +21,8 @@ UNRELEASED * Small actions definition refactor in `ExportJobViewSet/ExportJobViewSet` to allow easier overriding. * Add support for ordering in `export` * Add settings for DjangoFilterBackend and OrderingFilter in export api. -`DRF_EXPORT_DJANGO_FILTERS_BACKEND` with default `django_filters.rest_framework.DjangoFilterBackend` and -`DRF_EXPORT_ORDERING_BACKEND` with default `rest_framework.filters.OrderingFilter`. + `DRF_EXPORT_DJANGO_FILTERS_BACKEND` with default `django_filters.rest_framework.DjangoFilterBackend` and + `DRF_EXPORT_ORDERING_BACKEND` with default `rest_framework.filters.OrderingFilter`. 1.2.0 (2024-12-26) ------------------ diff --git a/docs/getting_started.rst b/docs/getting_started.rst index b2108e3..a612516 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -135,7 +135,7 @@ a ``status page``, where you can monitor the progress of the import/export proce A screenshot of Django Admin export status page Import/Export API ------------------ +---------------------------------------------------------------- The ``api.views.ExportJobViewSet`` and ``api.views.ImportJobViewSet`` are provided to create the corresponding viewsets for the resource. @@ -172,11 +172,7 @@ the OpenAPI specification will be available. Import/Export API actions mixins - -.. figure:: _static/images/action-bands-openapi.png - - A screenshot of the generated OpenAPI specification ------------------ +---------------------------------------------------------------- Alternatively you can use ``api.mixins.ExportStartActionMixin`` and ``api.mixins.ImportStartActionMixin`` to add to your current viewsets ability to create import/export jobs. @@ -187,3 +183,7 @@ and ``api.views.BaseImportJobViewSet`` or ``BaseImportJobForUsersViewSet`` to se * ``retrieve`` - Returns details of a job based on the provided ID. * ``cancel`` - Stops the import/export process and sets the job's status to ``CANCELLED``. * ``confirm`` - Confirms the import after the parse stage. This action is available only in import jobs. + +.. figure:: _static/images/action-bands-openapi.png + + A screenshot of the generated OpenAPI specification diff --git a/docs/installation.rst b/docs/installation.rst index 9149cfc..fa5057e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -81,7 +81,7 @@ By default, it uses the `mimetypes.types_map