Some document rst skeleton pages.

biothings · Apr 11, 2017 · 84a1da0 · 84a1da0
1 parent 06a558e
commit 84a1da0
Show file tree

Hide file tree

Showing 6 changed files with 87 additions and 8 deletions.
diff --git a/docs/_static/biothings_overview.png b/docs/_static/biothings_overview.png
diff --git a/docs/doc/data_loading.rst b/docs/doc/data_loading.rst
@@ -0,0 +1,12 @@
+Data loading tools
+==================
+
+The purpose of the BioThings data loading tools is to allow you to easily automate the parsing and uploading of your data to an Elasticsearch backend.
+
+Dumper
+~~~~~~
+
+Uploader
+~~~~~~~~
+
+
diff --git a/docs/doc/hub_tutorial.rst b/docs/doc/hub_tutorial.rst
@@ -1,4 +1,4 @@
-Biothings SDK tutorial
+BioThings SDK tutorial
 ----------------------
 
 The following tutorial shows how to create a "hub", a piece of software used to

diff --git a/docs/doc/tutorial.rst b/docs/doc/tutorial.rst
@@ -0,0 +1,26 @@
+Tutorials
+=========
+
+Data-loading tutorials
+----------------------
+
+See a full data-loading tutorial, showing the loading of taxonomy data, `here <hub_tutorial.html>`_.
+
+Parsing tutorials
+~~~~~~~~~~~~~~~~~
+
+Dumper tutorials
+~~~~~~~~~~~~~~~~
+
+Uploader tutorials
+~~~~~~~~~~~~~~~~~~
+
+Web tutorials
+-------------
+
+Handler tutorials
+~~~~~~~~~~~~~~~~~
+
+Query tutorials
+~~~~~~~~~~~~~~~
+
diff --git a/docs/doc/web.rst b/docs/doc/web.rst
@@ -0,0 +1,29 @@
+Web tools
+=========
+
+The BioThings.API web tools use the Tornado Web Server to respond to incoming API requests.
+
+Settings
+~~~~~~~~
+
+Handler
+~~~~~~~
+
+BiothingHandler
+---------------
+
+QueryHandler
+------------
+
+MetaDataHandler
+---------------
+
+Query
+~~~~~
+
+Query Builder
+~~~~~~~~~~~~~
+
+Result Transformer
+~~~~~~~~~~~~~~~~~~
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,19 +3,31 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. include:: doc/quick_start.rst
-.. include:: doc/hub_tutorial.rst
+BioThings.API
+=============
 
-.. toctree::
-   :maxdepth: 2
-
-   doc/quick_start
-   doc/hub_tutorial
+BioThings.API is a `Python-based <https://www.python.org/>`_ combined web and data-loading framework used to create and customize high-performance data APIs.  The BioThings.API data-loading tools allow you to automate the process of uploading your data to an `Elasticsearch <https://www.elastic.co/products/elasticsearch>`_ backend.  From here, the BioThings.API web framework - built on the high-concurrency `Tornado Web Server <http://www.tornadoweb.org/en/stable/>`_ - allows you to easily setup high-performance API endpoints to powerfully query your data using `Elasticsearch's full-text query capabilities and query language <https://www.elastic.co/guide/en/elasticsearch/reference/2.3/query-dsl-query-string-query.html#query-string-syntax>`_.  The `MyGene.Info <http://mygene.info/>`_ and `MyVariant.Info <http://myvariant.info/>`_ web services are examples of data APIs built and maintained using tools from BioThings.API.
 
 .. raw :: html
 
+    <div>
+    <center><img src="_static/biothings_overview.png" usemap="#overviewmap"></center>
+
+    <map name="overviewmap">
+        <area shape="rect" coords="7,7,314,284" href="doc/data_loading.html">
+        <area shape="rect" coords="7,313,313,458" href="doc/web.html">
+    </map>
+    </div>
+
     <div id="spacer" style="height:300px"></div>
 
+.. toctree::
+   :maxdepth: 3
+
+   doc/data_loading
+   doc/web
+   doc/tutorial
+
 .. Indices and tables
 .. ==================