[ci skip] generated apidoc docs

docs/.gitignore

@@ -0,0 +1 @@
+build

docs/source/conf.py

@@ -18,7 +18,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # -- General configuration ------------------------------------------------
 
@@ -30,6 +30,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.pngmath',

docs/source/index.rst

@@ -17,5 +17,4 @@ Welcome to Neural Monkey's documentation!
 
 **Sub-modules**
 
-.. toctree::
-   neuralmonkey.decoders.decoder
+.. toctree:: modules

docs/source/modules.rst

@@ -0,0 +1,7 @@
+neuralmonkey
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   neuralmonkey

docs/source/neuralmonkey.config.rst

@@ -0,0 +1,54 @@
+neuralmonkey.config package
+===========================
+
+Submodules
+----------
+
+neuralmonkey.config.config_loader module
+----------------------------------------
+
+.. automodule:: neuralmonkey.config.config_loader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.config.configuration module
+----------------------------------------
+
+.. automodule:: neuralmonkey.config.configuration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.config.exceptions module
+-------------------------------------
+
+.. automodule:: neuralmonkey.config.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.config.parsing module
+----------------------------------
+
+.. automodule:: neuralmonkey.config.parsing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.config.utils module
+--------------------------------
+
+.. automodule:: neuralmonkey.config.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.config
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.decoders.decoder.rst

@@ -1,5 +1,10 @@
-``neuralmonkey.decoders.decoder`` Module
+Module ``neuralmonkey.decoders.decoder``
 ========================================
 
+The main decoder module.
+
 .. automodule:: neuralmonkey.decoders.decoder
-		:members:
+   :members:
+   :private-members:
+   :special-members: __init__
+   :undoc-members:

docs/source/neuralmonkey.decoders.rst

@@ -0,0 +1,38 @@
+neuralmonkey.decoders package
+=============================
+
+Submodules
+----------
+
+neuralmonkey.decoders.decoder module
+------------------------------------
+
+.. automodule:: neuralmonkey.decoders.decoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.decoders.monster_decoder module
+--------------------------------------------
+
+.. automodule:: neuralmonkey.decoders.monster_decoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.decoders.sequence_classifier module
+------------------------------------------------
+
+.. automodule:: neuralmonkey.decoders.sequence_classifier
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.decoders
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.encoders.rst

@@ -0,0 +1,38 @@
+neuralmonkey.encoders package
+=============================
+
+Submodules
+----------
+
+neuralmonkey.encoders.cnn_encoder module
+----------------------------------------
+
+.. automodule:: neuralmonkey.encoders.cnn_encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.encoders.image_encoder module
+------------------------------------------
+
+.. automodule:: neuralmonkey.encoders.image_encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.encoders.sentence_encoder module
+---------------------------------------------
+
+.. automodule:: neuralmonkey.encoders.sentence_encoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.encoders
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.evaluators.rst

@@ -0,0 +1,54 @@
+neuralmonkey.evaluators package
+===============================
+
+Submodules
+----------
+
+neuralmonkey.evaluators.accuracy module
+---------------------------------------
+
+.. automodule:: neuralmonkey.evaluators.accuracy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.evaluators.bleu module
+-----------------------------------
+
+.. automodule:: neuralmonkey.evaluators.bleu
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.evaluators.bleu_ref module
+---------------------------------------
+
+.. automodule:: neuralmonkey.evaluators.bleu_ref
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.evaluators.edit_distance module
+--------------------------------------------
+
+.. automodule:: neuralmonkey.evaluators.edit_distance
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.evaluators.perplexity module
+-----------------------------------------
+
+.. automodule:: neuralmonkey.evaluators.perplexity
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.evaluators
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.nn.rst

@@ -0,0 +1,54 @@
+neuralmonkey.nn package
+=======================
+
+Submodules
+----------
+
+neuralmonkey.nn.bidirectional_rnn_layer module
+----------------------------------------------
+
+.. automodule:: neuralmonkey.nn.bidirectional_rnn_layer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.nn.mlp module
+--------------------------
+
+.. automodule:: neuralmonkey.nn.mlp
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.nn.noisy_gru_cell module
+-------------------------------------
+
+.. automodule:: neuralmonkey.nn.noisy_gru_cell
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.nn.pervasive_dropout_wrapper module
+------------------------------------------------
+
+.. automodule:: neuralmonkey.nn.pervasive_dropout_wrapper
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.nn.projection module
+---------------------------------
+
+.. automodule:: neuralmonkey.nn.projection
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.nn
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.processors.rst

@@ -0,0 +1,38 @@
+neuralmonkey.processors package
+===============================
+
+Submodules
+----------
+
+neuralmonkey.processors.bpe module
+----------------------------------
+
+.. automodule:: neuralmonkey.processors.bpe
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.processors.german module
+-------------------------------------
+
+.. automodule:: neuralmonkey.processors.german
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.processors.helpers module
+--------------------------------------
+
+.. automodule:: neuralmonkey.processors.helpers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.processors
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/neuralmonkey.readers.rst

@@ -0,0 +1,38 @@
+neuralmonkey.readers package
+============================
+
+Submodules
+----------
+
+neuralmonkey.readers.gzip_reader module
+---------------------------------------
+
+.. automodule:: neuralmonkey.readers.gzip_reader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.readers.multi_file_reader module
+---------------------------------------------
+
+.. automodule:: neuralmonkey.readers.multi_file_reader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+neuralmonkey.readers.plain_text_reader module
+---------------------------------------------
+
+.. automodule:: neuralmonkey.readers.plain_text_reader
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: neuralmonkey.readers
+    :members:
+    :undoc-members:
+    :show-inheritance: