Add some importer info to docs.

NBISweden · Aug 22, 2019 · 49d78d0 · 49d78d0
1 parent 8172f2e
commit 49d78d0
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 1 deletion.
diff --git a/docs/source/code.rst b/docs/source/code.rst
@@ -5,3 +5,4 @@ Code
    :maxdepth: 6
 
    backend
+   importer
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -16,6 +16,7 @@
 import sys
 sys.path.insert(0, os.path.abspath('../../'))
 sys.path.insert(0, os.path.abspath('../../backend/'))
+sys.path.insert(0, os.path.abspath('../../scripts/importer'))
 
 
 # -- Project information -----------------------------------------------------
@@ -168,7 +169,7 @@
 # -- Options for Epub output -------------------------------------------------
 
 # Bibliographic Dublin Core info.
-epub_title = project
+epub_title = 'SweFreq'
 
 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.

diff --git a/docs/source/importer.data_importer.data_importer.rst b/docs/source/importer.data_importer.data_importer.rst
@@ -0,0 +1,7 @@
+Data importer
+=============
+
+.. automodule:: data_importer.data_importer
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/importer.data_importer.raw_data_importer.rst b/docs/source/importer.data_importer.raw_data_importer.rst
@@ -0,0 +1,7 @@
+Variant importer
+================
+
+.. automodule:: data_importer.raw_data_importer
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/importer.data_importer.reference_set_importer.rst b/docs/source/importer.data_importer.reference_set_importer.rst
@@ -0,0 +1,7 @@
+Reference set importer
+======================
+
+.. automodule:: data_importer.reference_set_importer
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/importer.data_importer.rst b/docs/source/importer.data_importer.rst
@@ -0,0 +1,10 @@
+Data importer
+=============
+.. py:module:: data_importer
+
+.. toctree::
+
+   importer.data_importer.data_importer
+   importer.data_importer.raw_data_importer
+   importer.data_importer.reference_set_importer
+
diff --git a/docs/source/importer.rst b/docs/source/importer.rst
@@ -0,0 +1,6 @@
+Importer
+========
+
+.. toctree::
+
+   importer.data_importer