singa-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kaip...@apache.org
Subject incubator-singa git commit: SINGA-223 Use Sphinx to create the website.
Date Wed, 20 Jul 2016 12:49:15 GMT
Repository: incubator-singa
Updated Branches:
  refs/heads/dev 8c2a0e85e -> 8e3d3df61


SINGA-223 Use Sphinx to create the website.


Project: http://git-wip-us.apache.org/repos/asf/incubator-singa/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-singa/commit/8e3d3df6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-singa/tree/8e3d3df6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-singa/diff/8e3d3df6

Branch: refs/heads/dev
Commit: 8e3d3df61ef88efbe73813e3b46d4a1652242637
Parents: 8c2a0e8
Author: Moaz Reyad <moazreyad@gmail.com>
Authored: Wed Jul 20 16:17:36 2016 +0800
Committer: Moaz Reyad <moazreyad@gmail.com>
Committed: Wed Jul 20 20:12:36 2016 +0800

----------------------------------------------------------------------
 doc/_static/apache.jpg     | Bin 0 -> 2310 bytes
 doc/_static/singa.png      | Bin 0 -> 25000 bytes
 doc/_templates/layout.html |  58 +++++++++++++++++++++++++
 doc/build.sh               |  33 +++++++++++++++
 doc/conf.py                |   4 +-
 doc/index.rst              |  91 ++++++++++++++++++++++++++++++++++------
 6 files changed, 172 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/_static/apache.jpg
----------------------------------------------------------------------
diff --git a/doc/_static/apache.jpg b/doc/_static/apache.jpg
new file mode 100755
index 0000000..697e02d
Binary files /dev/null and b/doc/_static/apache.jpg differ

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/_static/singa.png
----------------------------------------------------------------------
diff --git a/doc/_static/singa.png b/doc/_static/singa.png
new file mode 100755
index 0000000..30be5c1
Binary files /dev/null and b/doc/_static/singa.png differ

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/_templates/layout.html
----------------------------------------------------------------------
diff --git a/doc/_templates/layout.html b/doc/_templates/layout.html
new file mode 100755
index 0000000..800a74d
--- /dev/null
+++ b/doc/_templates/layout.html
@@ -0,0 +1,58 @@
+{#
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements.  See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership.  The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+#}
+{% extends "!layout.html" %}
+     
+{% block footer %}
+
+
+<div class="rst-versions shift-up" data-toggle="rst-versions" role="note" aria-label="versions">
+<img src= "{{pathto('_static/'+ 'apache.jpg' , 1) }}">  
+ 
+  <span class="rst-current-version" data-toggle="rst-current-version">
+    <span class="fa fa-book"> incubator-singa </span>
+    v: {{ version }}
+    <span class="fa fa-caret-down"></span>
+  </span>
+  <div class="rst-other-versions">
+    <dl>
+      <dt>Languages</dt>
+      <dd><a href="/en/latest/">English</a></dd>
+      <dd><a href="/zh/latest/">中文</a></dd>	  
+	  <dd><a href="/jp/latest/">日本語</a></dd>
+	  <dd><a href="/kr/latest/">한국어</a></dd>
+	  <dd><a href="/it/latest/">Italiano</a></dd>
+	  <dd><a href="/ar/latest/">العربية</a></dd>
+    </dl>
+    <dl>
+      <dt>Versions</dt>
+      <dd><a href="/{{ language }}/latest/">latest</a></dd>
+      <dd><a href="/{{ language }}/0.3.0/">v0.3.0</a></dd>
+      <dd><a href="/{{ language }}/0.2.0/">v0.2.0</a></dd>
+	  <dd><a href="/{{ language }}/0.1.0/">v0.1.0</a></dd>
+    </dl>
+  </div>
+</div>
+
+ <a href="https://github.com/apache/incubator-singa">
+    <img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
+        src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png"
+        alt="Fork me on GitHub">
+</a>
+
+{{ super() }}
+{% endblock %}

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/build.sh
----------------------------------------------------------------------
diff --git a/doc/build.sh b/doc/build.sh
new file mode 100755
index 0000000..3af6ec1
--- /dev/null
+++ b/doc/build.sh
@@ -0,0 +1,33 @@
+#!/bin/sh
+
+#
+#  Licensed to the Apache Software Foundation (ASF) under one
+#  or more contributor license agreements.  See the NOTICE file
+#  distributed with this work for additional information
+#  regarding copyright ownership.  The ASF licenses this file
+#  to you under the Apache License, Version 2.0 (the
+#  "License"); you may not use this file except in compliance
+#  with the License.  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+echo "Building English version"
+make -e SPHINXOPTS="-D language='en'" html
+
+#echo "Building Chinese version"
+#make -e SPHINXOPTS="-D language='zh'" html
+
+#echo "Building Japanese version"
+#make -e SPHINXOPTS="-D language='jp'" html
+
+#echo "Building Italian version"
+#make -e SPHINXOPTS="-D language='it'" html 
+
+#echo "Building Arabic version"
+#make -e SPHINXOPTS="-D language='ar'" html

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/conf.py
----------------------------------------------------------------------
diff --git a/doc/conf.py b/doc/conf.py
old mode 100644
new mode 100755
index ccb1ae2..86dc031
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -149,7 +149,7 @@ html_theme = 'sphinx_rtd_theme'
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-# html_logo = None
+html_logo = '/singa.png'
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -202,7 +202,7 @@ html_static_path = ['_static']
 
 # If true, links to the reST sources are added to the pages.
 #
-# html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 #

http://git-wip-us.apache.org/repos/asf/incubator-singa/blob/8e3d3df6/doc/index.rst
----------------------------------------------------------------------
diff --git a/doc/index.rst b/doc/index.rst
old mode 100644
new mode 100755
index d50b443..ec727b1
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -3,37 +3,104 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Apache Singa's documentation!
-=================================
+Welcome to Apache Singa
+=======================
 
-.. image:: /image/singa.png
-	:scale: 50
+Recent News
+===========
 
+* The **third release** is now available, 20 April, 2016. `Download SINGA v0.3.0 <downloads.html>`_

 
-Contents:
+* The **second release** is now available, 14 Jan, 2016. `Download SINGA v0.2.0 <downloads.html>`_.
 
-.. toctree::
+* SINGA will be presented at `Strata+Hadoop <http://strataconf.com/big-data-conference-sg-2015/public/schedule/detail/45123>`_
on 2 Dec, 2015
+
+* SINGA was presented at `ACM Multimedia <http://www.acmmm.org/2015/at-a-glance/>`_
Best Paper session and Open Source Software Competition session, 26-30 Oct, 2015 (`Slides
<files/mm2015.ppt>`_)
+
+* The **first release** is now available, 8 Oct, 2015. `Download SINGA v0.1.0 <downloads.html>`_.
+
+* SINGA was presented at `workshop on deep learning <http://www.comp.nus.edu.sg/~dbsystem/singa/workshop>`_
 held on 16 Sep, 2015
+
+* SINGA was presented at `BOSS <http://boss.dima.tu-berlin.de/>`_ of `VLDB 2015 <http://www.vldb.org/2015/>`_
at Hawaii, 4 Sep, 2015. (slides: `overview <files/singa-vldb-boss.pptx>`_, `basic <files/basic-user-guide.pptx>`_,
`advanced <files/advanced-user-guide.pptx>`_)
+
+* SINGA was presented at `ADSC/I2R Deep Learning Workshop <http://adsc.illinois.edu/contact-us>`_,
25 Aug, 2015.
+
+* A tutorial on SINGA was given at VLDB summer school at Tsinghua University,  25-31 July,
2015.
+
+* A half day tutorial on SINGA was given at I2R, 29 June, 2015.
+
+* SINGA was presented at `DanaC <http://danac.org/>`_ of `SIGMOD 2015 <http://www.sigmod2015.org/index.shtml>`_
at Melbourne, 31 May - 4 June, 2015.
+
+* SINGA has been accepted by `Apache Incubator <http://incubator.apache.org/>`_, 17
March, 2015.
+
+Getting Started
+===============
+* The `Introduction <docs/overview.html>`_ page gives an overview of SINGA.
+
+* The `Installation <docs/installation.html>`_ guide describes details on downloading
and installing SINGA.
+
+* Please follow the `Quick Start <docs/quick-start.html>`_ guide to run simple applications
on SINGA.
+
+Documentation
+=============
+
+* Documentations are listed `here <docs.html>`_.
+
+* Code API can be found `here <api/index.html>`_.
 
+* Research publication list is available `here <http://www.comp.nus.edu.sg/~dbsystem/singa/research/publication/>`_.
+
+How to contribute
+=================
+  
+* Please subscribe to our development mailing list dev-subscribe@singa.incubator.apache.org.
+
+* If you find any issues using SINGA, please report it to the `Issue Tracker <https://issues.apache.org/jira/browse/singa>`_.
+
+* You can also contact with `SINGA committers <community.html>`_ directly.
+
+More details on contributing to SINGA is described `here <develop/how-contribute.html>`_
.
+
+Citing SINGA
+============
+
+Please cite the following two papers if you use SINGA in your research:
+
+* B. C. Ooi, K.-L. Tan, S. Wang, W. Wang, Q. Cai, G. Chen, J. Gao, Z. Luo, A. K. H. Tung,
Y. Wang, Z. Xie, M. Zhang, and K. Zheng. `SINGA: A distributed deep learning platform <http://www.comp.nus.edu.sg/~ooibc/singaopen-mm15.pdf>`_.
ACM Multimedia (Open Source Software Competition) 2015 (`BibTex <http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/bib-oss.txt>`_).
+
+* W. Wang, G. Chen, T. T. A. Dinh, B. C. Ooi, K.-L.Tan, J. Gao, and S. Wang. `SINGA: putting
deep learning in the hands of multimedia users <http://www.comp.nus.edu.sg/~ooibc/singa-mm15.pdf>`_.
ACM Multimedia 2015 (`BibTex <http://www.comp.nus.edu.sg/~dbsystem/singa//assets/file/bib-singa.txt>`_,
`Slides <files/mm2015.ppt>`_). 
+
+.. toctree::
+   :hidden:
+   
    downloads
    docs
 
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Development
+
    develop/schedule
    develop/how-contribute
    develop/contribute-code
    develop/contribute-docs
    
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: Community
+   
    community/source-repository
    community/mail-lists
    community/issue-tracking
    community/team-list
+   
 
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+License
+=======
+SINGA is released under `Apache License Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_.
 
 Disclaimers
 ===========


Mime
View raw message