Added documentation

yedivanseven · Sep 2, 2019 · 4a9e1e0 · 4a9e1e0
1 parent c67881f
commit 4a9e1e0
Show file tree

Hide file tree

Showing 108 changed files with 20,143 additions and 19 deletions.
diff --git a/docs/html/.buildinfo b/docs/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7b22b2250788829992c8385c2ed39a48
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/html/.doctrees/environment.pickle b/docs/html/.doctrees/environment.pickle
diff --git a/docs/html/.doctrees/index.doctree b/docs/html/.doctrees/index.doctree
diff --git a/docs/html/.doctrees/plsa.algorithms.base.doctree b/docs/html/.doctrees/plsa.algorithms.base.doctree
diff --git a/docs/html/.doctrees/plsa.algorithms.conditional_plsa.doctree b/docs/html/.doctrees/plsa.algorithms.conditional_plsa.doctree
diff --git a/docs/html/.doctrees/plsa.algorithms.doctree b/docs/html/.doctrees/plsa.algorithms.doctree
diff --git a/docs/html/.doctrees/plsa.algorithms.plsa.doctree b/docs/html/.doctrees/plsa.algorithms.plsa.doctree
diff --git a/docs/html/.doctrees/plsa.algorithms.result.doctree b/docs/html/.doctrees/plsa.algorithms.result.doctree
diff --git a/docs/html/.doctrees/plsa.corpus.doctree b/docs/html/.doctrees/plsa.corpus.doctree
diff --git a/docs/html/.doctrees/plsa.doctree b/docs/html/.doctrees/plsa.doctree
diff --git a/docs/html/.doctrees/plsa.pipeline.doctree b/docs/html/.doctrees/plsa.pipeline.doctree
diff --git a/docs/html/.doctrees/plsa.preprocessors.doctree b/docs/html/.doctrees/plsa.preprocessors.doctree
diff --git a/docs/html/.doctrees/plsa.visualize.doctree b/docs/html/.doctrees/plsa.visualize.doctree
diff --git a/docs/html/_sources/index.rst.txt b/docs/html/_sources/index.rst.txt
@@ -0,0 +1,25 @@
+.. PLSA documentation master file, created by
+   sphinx-quickstart on Mon Sep  2 16:20:59 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PLSA's documentation!
+================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   plsa.preprocessors
+   plsa.pipeline
+   plsa.corpus
+   plsa.algorithms
+   plsa.visualize
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/html/_sources/plsa.algorithms.base.rst.txt b/docs/html/_sources/plsa.algorithms.base.rst.txt
@@ -0,0 +1,7 @@
+plsa.algorithms.base module
+===========================
+
+.. autoclass:: plsa.algorithms.base.BasePLSA
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.algorithms.conditional_plsa.rst.txt b/docs/html/_sources/plsa.algorithms.conditional_plsa.rst.txt
@@ -0,0 +1,7 @@
+plsa.algorithms.conditional\_plsa module
+========================================
+
+.. automodule:: plsa.algorithms.conditional_plsa
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.algorithms.plsa.rst.txt b/docs/html/_sources/plsa.algorithms.plsa.rst.txt
@@ -0,0 +1,7 @@
+plsa.algorithms.plsa module
+===========================
+
+.. automodule:: plsa.algorithms.plsa
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.algorithms.result.rst.txt b/docs/html/_sources/plsa.algorithms.result.rst.txt
@@ -0,0 +1,7 @@
+plsa.algorithms.result module
+=============================
+
+.. automodule:: plsa.algorithms.result
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.algorithms.rst.txt b/docs/html/_sources/plsa.algorithms.rst.txt
@@ -0,0 +1,20 @@
+plsa.algorithms package
+=======================
+
+Submodules
+----------
+
+.. toctree::
+
+   plsa.algorithms.base
+   plsa.algorithms.conditional_plsa
+   plsa.algorithms.plsa
+   plsa.algorithms.result
+
+Module contents
+---------------
+
+.. automodule:: plsa.algorithms
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.corpus.rst.txt b/docs/html/_sources/plsa.corpus.rst.txt
@@ -0,0 +1,7 @@
+plsa.corpus module
+==================
+
+.. automodule:: plsa.corpus
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.pipeline.rst.txt b/docs/html/_sources/plsa.pipeline.rst.txt
@@ -0,0 +1,7 @@
+plsa.pipeline module
+====================
+
+.. automodule:: plsa.pipeline
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.preprocessors.rst.txt b/docs/html/_sources/plsa.preprocessors.rst.txt
@@ -0,0 +1,7 @@
+plsa.preprocessors module
+=========================
+
+.. automodule:: plsa.preprocessors
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.rst.txt b/docs/html/_sources/plsa.rst.txt
@@ -0,0 +1,27 @@
+plsa package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+
+   plsa.algorithms
+
+Submodules
+----------
+
+.. toctree::
+
+   plsa.corpus
+   plsa.pipeline
+   plsa.preprocessors
+   plsa.visualize
+
+Module contents
+---------------
+
+.. automodule:: plsa
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/html/_sources/plsa.visualize.rst.txt b/docs/html/_sources/plsa.visualize.rst.txt
@@ -0,0 +1,7 @@
+plsa.visualize module
+=====================
+
+.. automodule:: plsa.visualize
+   :members:
+   :undoc-members:
+   :show-inheritance: