add docs to GitHub Pages

docs/.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: 11006d2934eda90b93f1278a9dfa6c3c
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/abexp.rst.txt

@@ -0,0 +1,35 @@
+=====
+ABexp
+=====
+
+.. include:: badges.rst
+
+A/B testing is a methodology based on user experience which consists in comparing two or more variants of a single
+variable and determining which one performs better according to predefined criteria. It includes wide applications in
+the field of statistics.
+
+Many industries have been using A/B test to optimize business processes and user experience. There are existing tools
+and/or public libraries available to address this problem (mainly implemented in ``R``, fewer in ``Python``). However,
+they typically hide the statistical techniques running under the hood and they are mostly focused on a very specific
+aspect of the end-to-end experiment flow (e.g. a tool for post A/B test analysis which uses frequentist statistical
+techniques).
+
+A/B testing is a sensitive and critical aspect within Playtika organization. This pushed us to tackled this problem
+drawing attention to today's state-of-the art techniques.
+
+**ABexp**  is a ``Python`` library which aims to support users along the entire end-to-end A/B test
+experiment flow (see picture below). It contains A/B testing modules which use both frequentist and bayesian
+statistical approaches including bayesian generalized linear model (GLM).
+
+.. image:: img/experiment_flow.png
+  :width: 1000
+  :alt: A/B experiment flow end-to-end
+
+
+ABexp also provides detailed documentation and tutorials in order to help and guide users in running A/B test
+experiments.
+
+.. note::
+    ABexp is a generic library that can be directly used by analysts and data scientists as standalone product when
+    imported in  ``Jupyter Notebook`` or ``Python`` projects. It can also be used in the background of more complex
+    products that expose its functionalities through a user interface.

docs/_sources/api.rst.txt

@@ -0,0 +1,28 @@
+=================
+API documentation
+=================
+
+Architecture
+------------
+
+* ``abexp.core`` contains the most relevant modules to run A/B test experiments.
+
+   - :mod:`abexp.core.design`
+   - :mod:`abexp.core.planning`
+   - :mod:`abexp.core.allocation`
+   - :mod:`abexp.core.analysis_frequentist`
+   - :mod:`abexp.core.analysis_bayesian`
+
+* ``abexp.statistics`` provides statistical utils used in the modules above.
+
+   - :mod:`abexp.statistics.stats_metrics`
+   - :mod:`abexp.statistics.stats_tests`
+
+* ``abexp.visualization`` contains modules to display A/B test results.
+
+    - :mod:`abexp.visualization.analysis_plots`
+
+API
+---
+
+Please visit the full :ref:`API list <modindex>` for details.

docs/_sources/authors.rst.txt

@@ -0,0 +1,3 @@
+.. _authors:
+
+.. include:: ../../AUTHORS.rst

docs/_sources/badges.rst.txt

@@ -0,0 +1,21 @@
+.. Modify also README.md if you change the badges
+
+.. image:: https://img.shields.io/badge/build-passing-brightgreen
+   :target: https://img.shields.io/badge/build-passing-brightgreen
+   :alt: Build Status
+
+.. image:: https://img.shields.io/badge/docs-passing-brightgreen
+   :target: https://img.shields.io/badge/docs-passing-brightgreen
+   :alt: Docs Status
+
+.. image:: https://img.shields.io/badge/coverage-95%25-green
+   :target: https://img.shields.io/badge/coverage-95%25-green
+   :alt: Code coverage
+
+.. image:: https://img.shields.io/badge/version-0.0.1-blue
+   :target: https://img.shields.io/badge/version-0.0.1-blue
+   :alt: Development Status
+
+.. image:: https://img.shields.io/badge/license-MIT-blue
+   :target: https://img.shields.io/badge/license-MIT-blue
+   :alt: License Status

docs/_sources/fullapi.rst.txt

@@ -0,0 +1,72 @@
+===========
+abexp\.core
+===========
+
+abexp\.core\.design
+-------------------
+
+.. automodule:: abexp.core.design
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+abexp\.core\.planning
+---------------------
+
+.. automodule:: abexp.core.planning
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+abexp\.core\.allocation
+-----------------------
+
+.. automodule:: abexp.core.allocation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+abexp\.core\.analysis_frequentist
+---------------------------------
+
+.. automodule:: abexp.core.analysis_frequentist
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+abexp\.core\.analysis_bayesian
+------------------------------
+
+.. automodule:: abexp.core.analysis_bayesian
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+=================
+abexp\.statistics
+=================
+
+abexp\.statistics\.stats_metrics
+--------------------------------
+
+.. automodule:: abexp.statistics.stats_metrics
+    :members:
+    :undoc-members:
+
+abexp\.statistics\.stats_tests
+------------------------------
+
+.. automodule:: abexp.statistics.stats_tests
+    :members:
+    :undoc-members:
+
+====================
+abexp\.visualization
+====================
+
+abexp\.visualization\.analysis_plots
+------------------------------------
+
+.. automodule:: abexp.visualization.analysis_plots
+    :members:
+    :undoc-members:

docs/_sources/help.rst.txt

@@ -0,0 +1,14 @@
+****
+Help
+****
+
+This library was developed within Playtika Research in Lausanne, Switzerland. We are very welcome to help for any issue.
+Do not hesitate to reach us!
+
+Any feedback is also very much appreciated to improve this library together :)
+
+
+Contacts
+========
+
+Questions? Please contact the :ref:`authors <authors>`.

docs/_sources/index.rst.txt

@@ -0,0 +1,17 @@
+======================
+PyABtest documentation
+======================
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 1
+
+   abexp
+   installation
+   tutorials
+   api
+   help
+   authors
+   license

docs/_sources/installation.rst.txt

@@ -0,0 +1,74 @@
+.. Modify also the the README.md if you change docs/installation.rst
+
+============
+Installation
+============
+
+Latest release
+--------------
+
+This library is distributed on PyPI_ and
+can be installed with ``pip``. 
+
+The latest release is version ``0.0.1``.
+
+.. code:: console
+
+   $ pip install abexp
+
+The command above will automatically install all the dependencies listed in ``requirements.txt``. 
+
+.. _PyPI:  https://pypi.org/project/abexp/
+
+Info for developers
+-------------------
+
+The source code of the project is available on GitHub_.
+
+.. code:: console
+
+   $ git clone https://github.com/PlaytikaResearch/abexp.git
+
+You can install the library and the dependencies from the source code with one of the following commands:
+
+.. code:: console
+
+   $ pip install .                        # install library + dependencies
+   $ pip install .[develop]               # install library + dependencies + developer-dependencies
+   $ pip install -r requirements.txt      # install dependencies
+   $ pip install -r requirements-dev.txt  # install dependencies + developer-dependencies
+
+.. _GitHub: https://github.com/PlaytikaResearch/abexp
+
+As suggested by the authors of ``pymc3`` and ``pandoc``, we highly recommend to install these dependencies with
+``conda``:
+
+.. code:: console
+
+   $ conda install -c conda-forge pandoc
+   $ conda install -c conda-forge pymc3
+
+To create the file ``abexp.whl`` for the installation with ``pip`` run the following command:
+
+.. code:: console
+
+   $ python setup.py sdist bdist_wheel
+
+To create the HTML documentation run the following commands:
+
+.. code:: console
+
+   $ cd docs
+   $ make html
+
+Run tests
+---------
+
+Tests can be executed with ``pytest`` running the following commands:
+
+.. code:: console
+
+   $ cd tests
+   $ pytest                                      # run all tests
+   $ pytest test_testmodule.py                   # run all tests within a module
+   $ pytest test_testmodule.py -k test_testname  # run only 1 test

docs/_sources/license.rst.txt

@@ -0,0 +1,5 @@
+-------
+License
+-------
+
+.. include:: ../../LICENSE

docs/_sources/tutorials.rst.txt

@@ -0,0 +1,12 @@
+=========
+Tutorials
+=========
+
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/SampleSizeDetermination
+   tutorials/Allocation
+   tutorials/AnalysisFrequentistApproach
+   tutorials/AnalysisBayesianApproach
+   tutorials/AnalysisBootstrap