Fix doc

cokelaer · Oct 10, 2023 · c4a6068 · c4a6068
1 parent e426eb3
commit c4a6068
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 25 deletions.
diff --git a/README.rst b/README.rst
@@ -55,7 +55,7 @@ Example
       mycmap = c.cmap_linear('red', 'white', 'green(w3c)')
       cmap = c.test_colormap(mycmap)
 
-.. image:: http://colormap.readthedocs.io/en/latest/_images/index-1.png
+.. image:: https://colormap.readthedocs.io/en/latest/_images/quickstart-6.png
     :width: 50%
     :align: center
 
@@ -64,7 +64,7 @@ Example
       c = Colormap()
       c.plot_colormap('diverging')
 
-.. image:: http://colormap.readthedocs.io/en/latest/_images/colormaps.png
+.. image:: https://colormap.readthedocs.io/en/latest/_images/quickstart-4.png
     :width: 50%
     :align: center
 

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,31 +1,17 @@
 
-
 |version|, |today|
 
-.. include:: ../README.rst
-
-
+.. include:: ../../README.rst
 
 
 
 
-User Guide
-##################
 
 
 .. toctree::
     :maxdepth: 2
     :numbered:
 
     quickstart.rst
-
-Reference Guide
-##################
-
-
-.. toctree::
-    :maxdepth: 2
-    :numbered:
-
     references
 
diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
@@ -159,11 +159,18 @@ Create a linear colormap
 
 The simplest colormap are linear with 3 colors. In such case, we provide a
 method that is easy to use. Imagine you want a colormap from red to green with
-white color in between::
+white color in between:
+
+.. plot::
+   :include-source:
+   :width: 80%
+
+   from colormap import Colormap
+   c = Colormap()
+   cmap = c.cmap_linear('red', 'white', 'green')
+   cmap = c.test_colormap(cmap)
+
 
-    c = Colormap()
-    cmap = cmap_linear('red', 'white', 'green')
-    c.test_colormap(cmap)
 
 Here, we use color names, which are the xfree86 names. However, you could have
 used any format accepted by :class:`~colormap.Colors`::

diff --git a/doc/source/references.rst b/doc/source/references.rst
@@ -1,12 +1,12 @@
 Reference guide
-#################
+===================
 
 
 .. contents::
 
 
 colors
-==========
+------------
 
 .. automodule:: colormap.colors
     :members:
@@ -15,10 +15,10 @@ colors
 
 
 cmap module
-==============
+---------------
 .. automodule:: colormap.get_cmap
 
 xfree86 module
-==============
+----------------
 
 .. automodule:: colormap.xfree86