Merge c281357 into 0b47c8c

visgl · Apr 10, 2020 · 9feabc5 · 9feabc5
2 parents 0b47c8c + c281357
commit 9feabc5
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 17 deletions.
diff --git a/bindings/pydeck/CHANGELOG.md → bindings/pydeck/docs/CHANGELOG.rst b/bindings/pydeck/CHANGELOG.md → bindings/pydeck/docs/CHANGELOG.rst
@@ -1,26 +1,29 @@
-### pydeck CHANGELOG
+CHANGELOG
+================
+
+Releases and associated GitHub PRs for pydeck are documented here.
 
 0.3.0b4 - Apr 1 2020
-====================
-- Lock to deck.gl@8.2.0-alpha.1
+^^^^^^^^^^^^^^^^^^^^
+- Lock to deck.gl v8.2.0-alpha.1
 
 0.3.0b3 - Mar 28 2020
-=====================
+^^^^^^^^^^^^^^^^^^^^^
 - Fix binary data bug (#4416)
 
 0.3.0b2 - Mar 4 2020
-====================
+^^^^^^^^^^^^^^^^^^^^
 - Support rendering in Google Collab (#4337)
 
 0.3.0b1 - Feb 26 2020
-=====================
+^^^^^^^^^^^^^^^^^^^^^
 - Add support for dynamic deck.gl custom Layer registration (#4233)
 - Cut unused colors module (#4257)
 - Add support for background colors in standalone HTML renderer (#4242)
 - Support binary data transport (#4167)
 
 0.2.1 - Jan 28 2020
-===================
+^^^^^^^^^^^^^^^^^^^
 - Update to 0.2.1 (#4209) by removing deprecated pytest-runner to allow for conda-forge installation
 - ArcLayer, BitmapLayer, ColumnLayer examples (#4189)
 - Reduce JupyterLab bundle size (#4110)
@@ -29,7 +32,7 @@
 - Add pydeck release checklist (#4083)
 
 0.2.0 - Jan 4 2020
-==================
+^^^^^^^^^^^^^^^^^^
 - Add CDN-hosted bundle for standalone HTML rendering (#4003)
 - Update for new @deck.gl/json API and add additional tests (#4020)
 - Make a single bundle for use in standalone and Jupyter rendering (#4010)
@@ -38,7 +41,7 @@
 - Optionally surface pydeck warnings in widget UI (#3785)
 
 0.1.dev5 - Sep 26 2019
-======================
+^^^^^^^^^^^^^^^^^^^^^^
 - Allow user to modify tooltip text
 - Remove addition operator overload from pydeck (#3697)
 - Hard pydeck iframe height (#3684)

diff --git a/bindings/pydeck/docs/conf.py b/bindings/pydeck/docs/conf.py
@@ -39,9 +39,5 @@ def setup(app):
     if os.environ.get("READTHEDOCS"):
         print("RTD running in the following directory:", os.getcwd())
         subprocess.call(
-            "{python} bindings/pydeck/docs/scripts/embed_examples.py".format(python=sys.executable), shell=True,
+            "{python} embed_examples.py".format(python=sys.executable), shell=True,
         )
-    else:
-        from docs.scripts import embed_examples  # noqa
-
-        embed_examples.main()
diff --git a/bindings/pydeck/docs/gallery/custom_layer.png b/bindings/pydeck/docs/gallery/custom_layer.png
diff --git a/bindings/pydeck/docs/index.rst b/bindings/pydeck/docs/index.rst
@@ -13,8 +13,8 @@ Gallery
 
 .. include:: images.rst
 
-API reference
-^^^^^^^^^^^^^
+Overview
+^^^^^^^^
 
 `pydeck in Jupyter <jupyter.html>`__
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -76,6 +76,16 @@ Configure the lighting within a visualization.
    and mention ``pydeck`` in the title.
 
 
+Index
+^^^^^
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
+   Home <self>
+
+
 .. toctree::
    :maxdepth: 1
    :caption: Getting started
@@ -84,7 +94,7 @@ Configure the lighting within a visualization.
 
 .. toctree::
    :maxdepth: 1
-   :caption: Usage
+   :caption: API documentation
 
    layer
    deck
@@ -107,3 +117,16 @@ Configure the lighting within a visualization.
    tooltip
    custom_layers
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development
+
+   CHANGELOG
+
+.. raw:: html
+
+   <style>
+     .section #index {
+       display: none;
+     }
+   </style>