Enabling Coach Documentation to be run even when environments are not installed (#326)

docs_raw/README.md

@@ -3,7 +3,15 @@
 Coach uses Sphinx with a Read The Docs theme for its documentation website.
 The website is hosted on GitHub Pages, and is automatically pulled from the repository through the built docs directory.
 
-To build the documentation website locally, first install the following requirements:
+To build automatically, first go to 'docs_raw' directory; the following is installing all required packages, making html
+copying all new docs into 'coach/docs/'
+
+Run the following command (make sure the it's an executable file):
+```
+./build_docs.sh
+```
+
+To build manually the documentation website locally, first install the following requirements:
 
 ```
 pip install Sphinx

docs_raw/build_docs.sh

@@ -0,0 +1,24 @@
+#!/bin/bash
+
+echo "installing requirements..."
+
+pip3 install Sphinx
+pip3 install recommonmark
+pip3 install sphinx_rtd_theme
+pip3 install sphinx-autobuild
+pip3 install sphinx-argparse
+
+echo "Making docs..."
+
+make html
+
+echo "Copying new docs into coach/docs/"
+
+cp source/_static/css/custom.css build/html/_static/css/
+rm -rf ../docs/
+mkdir ../docs
+touch ../docs/.nojekyll
+cp -R build/html/* ../docs/
+rm -r build
+
+echo "Finished!"

docs_raw/source/conf.py

@@ -20,13 +20,13 @@ sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath('.'))))
 # -- Project information -----------------------------------------------------
 
 project = 'Reinforcement Learning Coach'
-copyright = '2018, Intel AI Lab'
+copyright = '2018-2019, Intel AI Lab'
 author = 'Intel AI Lab'
 
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '0.11.0'
+release = '0.12.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -49,6 +49,10 @@ extensions = [
     'sphinxarg.ext'
 ]
 
+# add the thid-party modules to be mocked to the autodoc_mod_imports configuration value
+autodoc_mock_imports = ['carla', 'suite', 'flags', 'vizdoom', 'dm_control', 'pybullet',
+                        'roboschool', 'pysc2', 'gymextensions']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs_raw/source/index.rst

@@ -25,7 +25,9 @@ Blog posts from the Intel® AI website:
 
 * `Release 0.10.0 <https://ai.intel.com/introducing-reinforcement-learning-coach-0-10-0/)>`_
 
-* `Release 0.11.0 <https://ai.intel.com/rl-coach-data-science-at-scale/>`_ (current release)
+* `Release 0.11.0 <https://ai.intel.com/rl-coach-data-science-at-scale/>`_
+
+* Release 0.12.1 (current release)
 
 You can find more details in the `GitHub repository <https://github.com/NervanaSystems/coach>`_.