Merge pull request #74 from martinRenou/doc

martinRenou · web-flow · commit 7c88e44ead9d · 2020-01-24T17:34:51.000+01:00
Pandas sphinx theme
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 ipycanvas
+git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -0,0 +1,4 @@
+code {
+  color: #005B81;
+  font-weight: bold;
+}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,8 +1,5 @@
 # -*- coding: utf-8 -*-
-import sphinx_rtd_theme
-
 extensions = [
-    'sphinx_rtd_theme',
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon'
 ]
@@ -22,16 +19,20 @@
 
 # Output file base name for HTML help builder.
 html_logo = "./images/ipycanvas_logo.svg"
-html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_favicon = "./images/ipycanvas_logo.ico"
+html_theme = "pandas_sphinx_theme"
 htmlhelp_basename = 'ipycanvasdoc'
 
 html_theme_options = dict(
-    style_nav_header_background='#0d6a0a'
+    github_url='https://github.com/martinRenou/ipycanvas'
 )
 
 html_js_files = [
     'goatcounter.js'
 ]
 
+html_css_files = [
+    'custom.css'
+]
+
 autodoc_member_order = 'bysource'
diff --git a/docs/source/drawing_text.rst b/docs/source/drawing_text.rst
@@ -1,9 +1,6 @@
 Drawing text
 ============
 
-Drawing text
-------------
-
 There are two methods that draw text on the canvas:
 
 - ``fill_text(text, x, y, max_width=None)``: Fills a given ``text`` at the given (``x``, ``y``) position. Optionally with a maximum width to draw.
diff --git a/docs/source/images/ipycanvas_logo.ico b/docs/source/images/ipycanvas_logo.ico
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,14 +6,17 @@ ipycanvas: Interactive Canvas in Jupyter
   :width: 300px
   :align: center
 
-Try it online:
---------------
+Try it online
+-------------
 
 You can try ipycanvas, without the need of installing anything on your computer, using `mybinder <https://mybinder.org/>`_ by clicking on this badge:
 
 .. image:: https://img.shields.io/badge/start-drawing!-F5A252.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFkAAABZCAMAAABi1XidAAAB8lBMVEX///9XmsrmZYH1olJXmsr1olJXmsrmZYH1olJXmsr1olJXmsrmZYH1olL1olJXmsr1olJXmsrmZYH1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olJXmsrmZYH1olL1olL0nFf1olJXmsrmZYH1olJXmsq8dZb1olJXmsrmZYH1olJXmspXmspXmsr1olL1olJXmsrmZYH1olJXmsr1olL1olJXmsrmZYH1olL1olLeaIVXmsrmZYH1olL1olL1olJXmsrmZYH1olLna31Xmsr1olJXmsr1olJXmsrmZYH1olLqoVr1olJXmsr1olJXmsrmZYH1olL1olKkfaPobXvviGabgadXmsqThKuofKHmZ4Dobnr1olJXmsr1olJXmspXmsr1olJXmsrfZ4TuhWn1olL1olJXmsqBi7X1olJXmspZmslbmMhbmsdemsVfl8ZgmsNim8Jpk8F0m7R4m7F5nLB6jbh7jbiDirOEibOGnKaMhq+PnaCVg6qWg6qegKaff6WhnpKofKGtnomxeZy3noG6dZi+n3vCcpPDcpPGn3bLb4/Mb47UbIrVa4rYoGjdaIbeaIXhoWHmZYHobXvpcHjqdHXreHLroVrsfG/uhGnuh2bwj2Hxk17yl1vzmljzm1j0nlX1olL3AJXWAAAAbXRSTlMAEBAQHx8gICAuLjAwMDw9PUBAQEpQUFBXV1hgYGBkcHBwcXl8gICAgoiIkJCQlJicnJ2goKCmqK+wsLC4usDAwMjP0NDQ1NbW3Nzg4ODi5+3v8PDw8/T09PX29vb39/f5+fr7+/z8/Pz9/v7+zczCxgAABC5JREFUeAHN1ul3k0UUBvCb1CTVpmpaitAGSLSpSuKCLWpbTKNJFGlcSMAFF63iUmRccNG6gLbuxkXU66JAUef/9LSpmXnyLr3T5AO/rzl5zj137p136BISy44fKJXuGN/d19PUfYeO67Znqtf2KH33Id1psXoFdW30sPZ1sMvs2D060AHqws4FHeJojLZqnw53cmfvg+XR8mC0OEjuxrXEkX5ydeVJLVIlV0e10PXk5k7dYeHu7Cj1j+49uKg7uLU61tGLw1lq27ugQYlclHC4bgv7VQ+TAyj5Zc/UjsPvs1sd5cWryWObtvWT2EPa4rtnWW3JkpjggEpbOsPr7F7EyNewtpBIslA7p43HCsnwooXTEc3UmPmCNn5lrqTJxy6nRmcavGZVt/3Da2pD5NHvsOHJCrdc1G2r3DITpU7yic7w/7Rxnjc0kt5GC4djiv2Sz3Fb2iEZg41/ddsFDoyuYrIkmFehz0HR2thPgQqMyQYb2OtB0WxsZ3BeG3+wpRb1vzl2UYBog8FfGhttFKjtAclnZYrRo9ryG9uG/FZQU4AEg8ZE9LjGMzTmqKXPLnlWVnIlQQTvxJf8ip7VgjZjyVPrjw1te5otM7RmP7xm+sK2Gv9I8Gi++BRbEkR9EBw8zRUcKxwp73xkaLiqQb+kGduJTNHG72zcW9LoJgqQxpP3/Tj//c3yB0tqzaml05/+orHLksVO+95kX7/7qgJvnjlrfr2Ggsyx0eoy9uPzN5SPd86aXggOsEKW2Prz7du3VID3/tzs/sSRs2w7ovVHKtjrX2pd7ZMlTxAYfBAL9jiDwfLkq55Tm7ifhMlTGPyCAs7RFRhn47JnlcB9RM5T97ASuZXIcVNuUDIndpDbdsfrqsOppeXl5Y+XVKdjFCTh+zGaVuj0d9zy05PPK3QzBamxdwtTCrzyg/2Rvf2EstUjordGwa/kx9mSJLr8mLLtCW8HHGJc2R5hS219IiF6PnTusOqcMl57gm0Z8kanKMAQg0qSyuZfn7zItsbGyO9QlnxY0eCuD1XL2ys/MsrQhltE7Ug0uFOzufJFE2PxBo/YAx8XPPdDwWN0MrDRYIZF0mSMKCNHgaIVFoBbNoLJ7tEQDKxGF0kcLQimojCZopv0OkNOyWCCg9XMVAi7ARJzQdM2QUh0gmBozjc3Skg6dSBRqDGYSUOu66Zg+I2fNZs/M3/f/Grl/XnyF1Gw3VKCez0PN5IUfFLqvgUN4C0qNqYs5YhPL+aVZYDE4IpUk57oSFnJm4FyCqqOE0jhY2SMyLFoo56zyo6becOS5UVDdj7Vih0zp+tcMhwRpBeLyqtIjlJKAIZSbI8SGSF3k0pA3mR5tHuwPFoa7N7reoq2bqCsAk1HqCu5uvI1n6JuRXI+S1Mco54YmYTwcn6Aeic+kssXi8XpXC4V3t7/ADuTNKaQJdScAAAAAElFTkSuQmCC
    :target: https://mybinder.org/v2/gh/martinRenou/ipycanvas/stable?filepath=examples
 
+Index
+-----
+
 .. toctree::
     :caption: Installation
     :maxdepth: 2
@@ -24,15 +27,7 @@ You can try ipycanvas, without the need of installing anything on your computer,
     :caption: Usage
     :maxdepth: 2
 
-    basic_usage
-    drawing_shapes
-    drawing_text
-    drawing_images
-    retrieve_images
-    canvas_state
-    transformations
-    events
-    advanced
+    usage
 
 .. toctree::
     :caption: API Reference
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -1,21 +1,24 @@
 .. _installation:
 
+Installation
+============
+
 Using pip
-=========
+---------
 
 .. code:: bash
 
     pip install ipycanvas
 
 Using conda
-===========
+-----------
 
 .. code:: bash
 
     conda install -c conda-forge ipycanvas
 
 JupyterLab extension
-====================
+--------------------
 
 If you have JupyterLab, you will also need to install the JupyterLab extension. In order to install the JupyterLab extension,
 you will need ``npm`` to be installed. You can easily install ``npm`` with conda:
@@ -31,7 +34,7 @@ Then you can install the JupyterLab extension:
     jupyter labextension install @jupyter-widgets/jupyterlab-manager ipycanvas
 
 Development installation
-========================
+------------------------
 
 For a development installation (requires npm):
 
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -0,0 +1,16 @@
+Usage
+=====
+
+.. toctree::
+    :caption: Usage
+    :maxdepth: 2
+
+    basic_usage
+    drawing_shapes
+    drawing_text
+    drawing_images
+    retrieve_images
+    canvas_state
+    transformations
+    events
+    advanced

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`ipycanvas`
	`2`	`+git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +code {
 +  color: #005B81;
 +  font-weight: bold;
 +}