Changes to documentation structure

CoEDL · Jul 8, 2020 · 61989b0 · 61989b0
1 parent 91db348
commit 61989b0
Show file tree

Hide file tree

Showing 19 changed files with 101 additions and 109 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -22,5 +22,5 @@ help:
 %: Makefile
 	rm -rf _build
 	rm -rf elpis
-	@$(SPHINXAPIDOC) -o "$(APIDOCSDIR)" "$(SOURCEAPIDIR)" "../elpis/transformer"
+	@$(SPHINXAPIDOC) -fMT -o "$(APIDOCSDIR)" "$(SOURCEAPIDIR)"
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,9 @@
+API Documentation
+=================
+
+Information on specific functions, classes, and methods.
+
+.. toctree::
+   :glob:
+
+   elpis/*
diff --git a/docs/conf.py b/docs/conf.py
@@ -49,7 +49,8 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+# We also exclude the "ugly" auto-generated elpis.rst file and replace it with our own.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'elpis/elpis.rst']
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/elpis/elpis.endpoints.rst b/docs/elpis/elpis.endpoints.rst
@@ -1,6 +1,11 @@
 elpis.endpoints package
 =======================
 
+.. automodule:: elpis.endpoints
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -44,11 +49,3 @@ elpis.endpoints.transcription module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.endpoints
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.common.input.rst b/docs/elpis/elpis.engines.common.input.rst
@@ -1,6 +1,11 @@
 elpis.engines.common.input package
 ==================================
 
+.. automodule:: elpis.engines.common.input
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -76,11 +81,3 @@ elpis.engines.common.input.trs\_to\_json module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.common.input
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.common.objects.rst b/docs/elpis/elpis.engines.common.objects.rst
@@ -1,6 +1,11 @@
 elpis.engines.common.objects package
 ====================================
 
+.. automodule:: elpis.engines.common.objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -76,11 +81,3 @@ elpis.engines.common.objects.transcription module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.common.objects
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.common.output.rst b/docs/elpis/elpis.engines.common.output.rst
@@ -1,6 +1,11 @@
 elpis.engines.common.output package
 ===================================
 
+.. automodule:: elpis.engines.common.output
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -20,11 +25,3 @@ elpis.engines.common.output.textgrid\_to\_elan module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.common.output
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.common.rst b/docs/elpis/elpis.engines.common.rst
@@ -1,6 +1,11 @@
 elpis.engines.common package
 ============================
 
+.. automodule:: elpis.engines.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------
 
@@ -11,11 +16,3 @@ Subpackages
    elpis.engines.common.objects
    elpis.engines.common.output
    elpis.engines.common.utilities
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.common
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.common.utilities.rst b/docs/elpis/elpis.engines.common.utilities.rst
@@ -1,6 +1,11 @@
 elpis.engines.common.utilities package
 ======================================
 
+.. automodule:: elpis.engines.common.utilities
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -44,11 +49,3 @@ elpis.engines.common.utilities.logger module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.common.utilities
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.kaldi.inference.rst b/docs/elpis/elpis.engines.kaldi.inference.rst
@@ -1,6 +1,11 @@
 elpis.engines.kaldi.inference package
 =====================================
 
+.. automodule:: elpis.engines.kaldi.inference
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -12,11 +17,3 @@ elpis.engines.kaldi.inference.generate\_infer\_files module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.kaldi.inference
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.kaldi.input.rst b/docs/elpis/elpis.engines.kaldi.input.rst
@@ -1,6 +1,11 @@
 elpis.engines.kaldi.input package
 =================================
 
+.. automodule:: elpis.engines.kaldi.input
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -12,11 +17,3 @@ elpis.engines.kaldi.input.json\_to\_kaldi module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.kaldi.input
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.kaldi.objects.rst b/docs/elpis/elpis.engines.kaldi.objects.rst
@@ -1,6 +1,11 @@
 elpis.engines.kaldi.objects package
 ===================================
 
+.. automodule:: elpis.engines.kaldi.objects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -20,11 +25,3 @@ elpis.engines.kaldi.objects.transcription module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.kaldi.objects
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.kaldi.rst b/docs/elpis/elpis.engines.kaldi.rst
@@ -1,6 +1,11 @@
 elpis.engines.kaldi package
 ===========================
 
+.. automodule:: elpis.engines.kaldi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------
 
@@ -22,11 +27,3 @@ elpis.engines.kaldi.errors module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis.engines.kaldi
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.engines.persephone.rst b/docs/elpis/elpis.engines.persephone.rst
@@ -1,9 +1,6 @@
 elpis.engines.persephone package
 ================================
 
-Module contents
----------------
-
 .. automodule:: elpis.engines.persephone
    :members:
    :undoc-members:

diff --git a/docs/elpis/elpis.engines.rst b/docs/elpis/elpis.engines.rst
@@ -1,6 +1,11 @@
 elpis.engines package
 =====================
 
+.. automodule:: elpis.engines
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------
 
@@ -10,11 +15,3 @@ Subpackages
    elpis.engines.common
    elpis.engines.kaldi
    elpis.engines.persephone
-
-Module contents
----------------
-
-.. automodule:: elpis.engines
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.rst b/docs/elpis/elpis.rst
@@ -1,6 +1,11 @@
 elpis package
 =============
 
+.. automodule:: elpis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Subpackages
 -----------
 
@@ -9,6 +14,7 @@ Subpackages
 
    elpis.endpoints
    elpis.engines
+   elpis.transformer
 
 Submodules
 ----------
@@ -29,11 +35,3 @@ elpis.blueprint module
    :undoc-members:
    :show-inheritance:
 
-
-Module contents
----------------
-
-.. automodule:: elpis
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/elpis/elpis.transformer.rst b/docs/elpis/elpis.transformer.rst
@@ -0,0 +1,27 @@
+elpis.transformer package
+=========================
+
+.. automodule:: elpis.transformer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+elpis.transformer.elan module
+-----------------------------
+
+.. automodule:: elpis.transformer.elan
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+elpis.transformer.test\_transformer module
+------------------------------------------
+
+.. automodule:: elpis.transformer.test_transformer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
diff --git a/docs/elpis/modules.rst b/docs/elpis/modules.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,7 +13,7 @@ Welcome! You've found your way to the documentation for the Elpis
    usage/installation
    usage/quick_start_guide
    usage/user_manual
-   elpis/modules
+   api
 
 
 Indices and tables