]> git.parisson.com Git - timeside.git/commitdiff
add Docker image infos, add new deps
authorGuillaume Pellerin <yomguy@parisson.com>
Tue, 30 Sep 2014 21:33:04 +0000 (23:33 +0200)
committerGuillaume Pellerin <yomguy@parisson.com>
Tue, 30 Sep 2014 21:33:04 +0000 (23:33 +0200)
README.rst
doc/source/conf.py
setup.py

index 58ac484e95fa576fed585f3f60abe97de7df7cb4..32b26610da61fef0f9fcb8bf36ec3c5afd8a4c95 100644 (file)
@@ -296,6 +296,17 @@ Optional:
 User Interfaces
 ===============
 
+Python
+-------
+
+Of course all the TimeSide are available in our beloved python envionment.
+As IPython is really great for discovering objects with completion, writing notebooks, we strongly advise to install and use it::
+
+  sudo apt-get install ipython
+  ipython
+  >>> import timeside
+
+
 Shell
 ------
 
@@ -421,6 +432,24 @@ To stop the virtual box::
  vagrant halt
 
 
+Docker
+-------
+
+Docker is a great tool for developping and deploying processing environments! Our docker container includes all the necessary packages and environments for development and production with TimeSide.
+
+Simply pull our dev image and run::
+
+  sudo docker pull yomguy/timeside
+  sudo docker run -i -t yomguy/timeside bash
+
+To start a development process, it is advised to checkout the dev branch::
+
+  cd /root/apps/TimeSide
+  git checkout dev
+
+More infos: https://registry.hub.docker.com/u/yomguy/timeside/
+
+
 Sponsors and Partners
 =====================
 
index c9184a6899eb2a80a93a155146bc4c6b4d312a4c..d36a1edc79fbea06750473964cb26e7ddf16e5a0 100644 (file)
@@ -106,7 +106,10 @@ modindex_common_prefix = ['timeside.']
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+# html_theme = 'default'
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
index 72a28465ba09a61531e4816513b3719403f05d68..566ead5216d13e0d9036a34e245e2c80bebf41ac 100755 (executable)
--- a/setup.py
+++ b/setup.py
@@ -61,7 +61,8 @@ setup(
         'djangorestframework',
         'south',
         'traits',
-        'networkx'
+        'networkx',
+        'sphinx_rtd_theme',
         ],
     platforms=['OS Independent'],
     license='Gnu Public License V2',