Docs3

docs/conf.py

@@ -12,13 +12,14 @@
 # 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.
 #
-# import os
-# import sys
+from __future__ import print_function
+import sys
+import os
+#import sphinx_gallery
 # sys.path.insert(0, os.path.abspath('.'))
 
-
 # -- Project information -----------------------------------------------------
-
+ 
 project = 'steppy'
 copyright = '2018, neptune.ml'
 author = 'Kamil A. Kaczmarek and Jakub Czakon'
@@ -41,16 +42,22 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
+    'nbsphinx',
+    'sphinx.ext.mathjax'
 ]
-
+autosummary_generate = ['module.rst', 'steppy.rst']
+# 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','**.ipynb_checkpoints']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.ipynb']
 
 # The master toctree document.
 master_doc = 'index'
@@ -62,10 +69,6 @@
 # Usually you set "language" from the command line for these cases.
 language = None
 
-# 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']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -87,7 +90,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_build/html/_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -158,4 +161,4 @@
 
 
 # -- Extension configuration -------------------------------------------------
-extensions = ['sphinx.ext.napoleon']
+#extensions = ['sphinx.ext.napoleon']

docs/generated/steppy.rst

@@ -1,6 +1,14 @@
 steppy package
 ==============
 
+.. automodule:: steppy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
 steppy.adapter module
 ---------------------
 
@@ -25,3 +33,4 @@ steppy.utils module
     :undoc-members:
     :show-inheritance:
 
+

docs/index.rst

@@ -1,98 +1,18 @@
 Welcome to steppy
 ==================================
 
-
 .. toctree::
-   :maxdepth: 2
-   :caption: Module contents:
-
-
-API documentation
-~~~~~~~~~~~~~~~~~
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
-
-What is Steppy?
-~~~~~~~~~~~~~~~
-
-Steppy is a lightweight, open-source, Python 3 library for fast and
-reproducible experimentation. It lets data scientist focus on data
-science, not on software development issues. Steppy’s minimal interface
-does not impose constraints, however, enables clean machine learning
-pipeline design.
-
-What problem steppy solves?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In the course of the project, data scientist faces multiple problems.
-Difficulties with reproducibility and lack of the ability to prepare
-experiments quickly are two particular examples. Steppy address both
-problems by introducing two simple abstractions: ``Step`` and
-``Tranformer``. We consider it minimal interface for building machine
-learning pipelines.
-
-``Step`` is a wrapper over the transformer and handles multiple aspects
-of the execution of the pipeline, such as saving intermediate results
-(if needed), checkpoiting the model during training and much more.
-``Tranformer`` in turn, is purely computational, data scientist-defined
-piece that takes an input data and produces some output data. Typical
-Transformers are neural netowrk, machine learning algorithms and pre- or
-post-processing routines.
-
-Start using steppy
-~~~~~~~~~~~~~~~~~~
-
-Installation
-^^^^^^^^^^^^
-
-Steppy requires ``python3.5`` or above.
-
-.. code:: bash
+   :maxdepth: 4
+   :numbered:
+   :caption: Table of Contents
+   :name: mastertoc
 
-   pip3 install steppy
+   nbdoc/intro.ipynb
+   nbdoc/Contributing.ipynb
+   nbdoc/testdoc.ipynb   
+   nbdoc/FAQ.ipynb
+   generated/modules
 
-*(you probably want to install it in
-your* \ `virtualenv <https://virtualenv.pypa.io/en/stable>`__\ *)*
-
-Resources
-~~~~~~~~~
-
-1. `Documentation <https://steppy.readthedocs.io/en/latest>`__
-2. `Source <https://github.com/minerva-ml/steppy>`__
-3. `Bugs reports <https://github.com/minerva-ml/steppy/issues>`__
-4. `Feature requests <https://github.com/minerva-ml/steppy/issues>`__
-5. Tutorial notebooks (`their repository <https://github.com/minerva-ml/steppy-examples>`__):
-
-   -  `Getting started <https://github.com/minerva-ml/steppy-examples/blob/master/tutorials/1-getting-started.ipynb>`__
-   -  `Steps with multiple inputs <https://github.com/minerva-ml/steppy-examples/blob/master/tutorials/2-multi-step.ipynb>`__
-   -  `Advanced adapters <https://github.com/minerva-ml/steppy-examples/blob/master/tutorials/3-adapter_advanced.ipynb>`__
-   -  `Caching and persistance <https://github.com/minerva-ml/steppy-examples/blob/master/tutorials/4-caching-persistence.ipynb>`__
-   -  `Steppy with Keras <https://github.com/minerva-ml/steppy-examples/blob/master/tutorials/5-steps-with-keras.ipynb>`__
-
-Feature Requests
-~~~~~~~~~~~~~~~~
-
-Please send us your ideas on how to improve steppy library! We are
-looking for your comments here: `Feature
-requests <https://github.com/minerva-ml/steppy/issues>`__.
-
-Roadmap
-~~~~~~~
-
-At this point steppy is early-stage library heavily
-tested on multiple machine learning challenges
-(`data-science-bowl <https://github.com/minerva-ml/open-solution-data-science-bowl-2018>`__,
-`toxic-comment-classification-challenge <https://github.com/minerva-ml/open-solution-toxic-comments>`__,
-`mapping-challenge <https://github.com/minerva-ml/open-solution-mapping-challenge>`__)
-and educational projects
-(`minerva-advanced-data-scientific-training <https://github.com/minerva-ml/minerva-training-materials>`__).
-
-We are developing steppy towards practical tool for data
-scientists who can run their experiments easily and change their
-pipelines with just few manipulations in the code.
 
 Related projects
 ~~~~~~~~~~~~~~~~
@@ -102,15 +22,17 @@ We are also building
 collection of high quality implementations of the top deep learning
 architectures -> all of them with the same, intuitive interface.
 
-Contributing
-~~~~~~~~~~~~
 
-You are welcome to contribute to the Steppy library. Please check
-`CONTRIBUTING <https://github.com/minerva-ml/steppy/blob/master/CONTRIBUTING.md>`__
-for more information.
+
+API documentation
+~~~~~~~~~~~~~~~~~
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
 
 Terms of use
 ~~~~~~~~~~~~
 
 Steppy is
-`MIT-licesed <https://github.com/minerva-ml/steppy/blob/master/LICENSE>`__.
+`MIT-licensed <https://github.com/minerva-ml/steppy/blob/master/LICENSE>`__.