-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from saritasa-nest/update-docs
- Loading branch information
Showing
14 changed files
with
269 additions
and
70 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
===== | ||
Admin | ||
===== | ||
|
||
.. automodule:: import_export_extensions.admin.model_admins.export_job_admin | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.model_admins.import_job_admin | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.model_admins.mixins | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.forms.export_admin_form | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.forms.import_admin_form | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.mixins.base | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.mixins.export_mixin | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.mixins.import_export_mixin | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.mixins.import_mixin | ||
:members: | ||
|
||
.. automodule:: import_export_extensions.admin.widgets | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
==================== | ||
API (Rest Framework) | ||
==================== | ||
|
||
.. autoclass:: import_export_extensions.api.CreateExportJob | ||
:members: create, validate | ||
|
||
.. autoclass:: import_export_extensions.api.CreateImportJob | ||
:members: create, validate | ||
|
||
.. autoclass:: import_export_extensions.api.ExportJobSerializer | ||
:members: | ||
|
||
.. autoclass:: import_export_extensions.api.ImportJobSerializer | ||
:members: | ||
|
||
.. autoclass:: import_export_extensions.api.ProgressSerializer | ||
:members: | ||
|
||
.. attribute:: info | ||
:type: ProgressInfoSerializer | ||
:value: {"current": 0, "total": 0} | ||
|
||
Shows current and total imported/exported values | ||
|
||
.. autoclass:: import_export_extensions.api.ProgressInfoSerializer | ||
:members: | ||
|
||
.. attribute:: current | ||
:type: int | ||
:value: 0 | ||
|
||
Shows number of imported/exported objects | ||
|
||
.. attribute:: total | ||
:type: int | ||
:value: 0 | ||
|
||
Shows total objects to import/export |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
====== | ||
Models | ||
====== | ||
|
||
.. autoclass:: import_export_extensions.models.ExportJob | ||
:members: | ||
|
||
.. autoclass:: import_export_extensions.models.ImportJob | ||
:members: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
===== | ||
Usage | ||
===== | ||
=============== | ||
Getting started | ||
=============== | ||
|
||
Resources | ||
--------- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.