add importer + ORM models doc files

Wikidata · Jul 4, 2019 · 42f6458 · 42f6458
1 parent 5da6608
commit 42f6458
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 0 deletions.
diff --git a/docs/importer.rst b/docs/importer.rst
@@ -0,0 +1,42 @@
+:mod:`~soweego.importer`
+========================
+
+.. automodule:: soweego.importer
+    :members:
+    :exclude-members: cli
+
+
+:mod:`~soweego.importer.base_dump_extractor`
+--------------------------------------------
+
+.. automodule:: soweego.importer.base_dump_extractor
+    :members:
+
+
+:mod:`~soweego.importer.discogs_dump_extractor`
+-----------------------------------------------
+
+.. automodule:: soweego.importer.discogs_dump_extractor
+    :members:
+
+
+:mod:`~soweego.importer.imdb_dump_extractor`
+--------------------------------------------
+
+.. automodule:: soweego.importer.imdb_dump_extractor
+    :members:
+
+
+:mod:`~soweego.importer.musicbrainz_dump_extractor`
+---------------------------------------------------
+
+.. automodule:: soweego.importer.musicbrainz_dump_extractor
+    :members:
+
+
+:mod:`~soweego.importer.importer`
+---------------------------------
+
+.. automodule:: soweego.importer.importer
+    :members:
+    :exclude-members: import_cli, check_links_cli
diff --git a/docs/index.rst b/docs/index.rst
@@ -143,6 +143,8 @@ API documentation
 .. toctree::
    :maxdepth: 2
 
+   importer
+   models
    ingestor
    linker
    validator

diff --git a/docs/models.rst b/docs/models.rst
@@ -0,0 +1,54 @@
+:mod:`~soweego.importer.models`
+===============================
+
+.. automodule:: soweego.importer.models
+    :members:
+
+
+:mod:`~soweego.importer.models.base_entity`
+-------------------------------------------
+
+.. automodule:: soweego.importer.models.base_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.base_link_entity`
+------------------------------------------------
+
+.. automodule:: soweego.importer.models.base_link_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.base_nlp_entity`
+-----------------------------------------------
+
+.. automodule:: soweego.importer.models.base_nlp_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.discogs_entity`
+----------------------------------------------
+
+.. automodule:: soweego.importer.models.discogs_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.imdb_entity`
+-------------------------------------------
+
+.. automodule:: soweego.importer.models.imdb_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.musicbrainz_entity`
+--------------------------------------------------
+
+.. automodule:: soweego.importer.models.musicbrainz_entity
+    :members:
+
+
+:mod:`~soweego.importer.models.mix_n_match`
+-------------------------------------------
+
+.. automodule:: soweego.importer.models.mix_n_match
+    :members: