Merge pull request #188 from plotly/autodoc_style_bis

nicolaskruchten · web-flow · commit 4d2d88cb35c4 · 2019-11-11T15:04:44.000-05:00
Autodoc style bis
diff --git a/apidoc/_static/plotly-style.css b/apidoc/_static/plotly-style.css
@@ -11,3 +11,19 @@
 .body {
     font-family: "Open Sans", sans-serif;
 }
+.navbar-brand img {
+    height: 30px;
+    margin-top: 4px;
+}
+
+.navbar .container {
+    padding-top: 8px;
+}
+
+a {
+    color: #2391fe !important;
+}
+
+code {
+    color: #2391fe !important;
+}
diff --git a/apidoc/_templates/class_figure.rst b/apidoc/_templates/class_figure.rst
@@ -4,24 +4,28 @@
 
 .. currentmodule:: {{ module }}
 
-.. autoclass:: {{ objname }}
+.. autosummary::
+   :toctree: generated/
+
+   Figure
 
+   Figure.show
+   Figure.add_traces
+   Figure.update_traces
+   Figure.update_layout
+
+
+.. autoclass:: {{ objname }}
    {% block methods %}
    .. automethod:: __init__
-   .. automethod:: show
-   .. automethod:: update_layout
-   .. automethod:: add_traces
    {% endblock %}
 
-Other methods
-{{ underline }}==============
-
-.. autosummary::
-   :toctree: generated/
-   
-   plotly.graph_objects.{{ objname }}
 
+.. autoclass:: {{ objname }}
+   :members:
+   :inherited-members:
 
 .. raw:: html
 
     <div class="clearer"></div>
+
diff --git a/apidoc/_templates/trace.rst b/apidoc/_templates/trace.rst
@@ -1,5 +1,5 @@
 :mod:`{{module}}`.{{objname}}
-{{ underline }}
+{{ underline }}============================
 
 
 .. currentmodule:: {{ module }}
@@ -12,7 +12,7 @@
 
 
 :mod:`{{module}}`.{{objname.lower()}}
-{{ underline }}
+{{ underline }}================================
 
 .. autosummary::
    
diff --git a/apidoc/figure.rst b/apidoc/figure.rst
diff --git a/apidoc/figure_factory.rst b/apidoc/figure_factory.rst
@@ -1,6 +1,6 @@
 .. _ff:
 
-Figure Factory
+`plotly.figure_factory`: helper methods for building specific complex charts
 ==============
 
 .. currentmodule:: plotly.figure_factory
@@ -23,6 +23,6 @@ Figure Factory
    create_streamline
    create_table
    create_ternary_contour
-   create_trisurf           
+   create_trisurf
    create_violin
 
diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst
@@ -1,6 +1,6 @@
 .. _graph-objects:
 
-Graph objects: figures, traces and layout
+`plotly.graph_objects`: low-level interface to figures, traces and layout
 =========================================
 
 .. currentmodule:: plotly.graph_objects
@@ -11,11 +11,14 @@ Graph objects: figures, traces and layout
 
    >>> import plotly.graph_objects as go
 
-.. toctree::
-   :maxdepth: 1
-   :caption: Figure:
+Figure
+------
+
+.. autosummary::
+   :toctree: generated/
+   :template: class_figure.rst
 
-   figure.rst
+   Figure  
 
 
 Layout
diff --git a/apidoc/index.rst b/apidoc/index.rst
@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-plotly API reference
+Python API reference for `plotly`
 ====================
 
 This is the reference of plotly's API. Also see `plotly's documentation website <https://plot.ly/python>`_.
@@ -12,11 +12,11 @@ Submodules
 ----------
 
 
-* :ref:`Plotly express <px>`
-* :ref:`Graph objects: figures, traces and layout <graph-objects>`
-* :ref:`Subplots <subplots>`
-* :ref:`Figure Factory <ff>`
-* :ref:`I/O <io>`
+* :ref:`Plotly Express: high-level interface for data visualization <px>`
+* :ref:`Graph Objects: low-level interface to figures, traces and layout <graph-objects>`
+* :ref:`Subplots: helper function for layout out multi-plot figures <subplots>`
+* :ref:`Figure Factories: helper methods for building specific complex charts <ff>`
+* :ref:`I/O: low-level interface for displaying, reading and writing figures <io>`
 
 Full reference list
 -------------------
diff --git a/apidoc/io.rst b/apidoc/io.rst
@@ -1,6 +1,6 @@
 .. _io:
 
-I/O
+`plotly.io`: low-level interface for displaying, reading and writing figures
 ==============
 
 .. currentmodule:: plotly.io
diff --git a/apidoc/px.rst b/apidoc/px.rst
@@ -1,6 +1,6 @@
 .. _px:
 
-Plotly express: `plotly.express`
+`plotly.express`: high-level interface for data visualization
 ================================
 
 The `plotly.express <https://plot.ly/python/plotly-express/>`_ module is
diff --git a/apidoc/subplots.rst b/apidoc/subplots.rst
@@ -1,6 +1,6 @@
 .. _subplots:
 
-Subplots: `plotly.subplots`
+`plotly.subplots`: helper function for laying out multi-plot figures
 ===========================
 
 .. currentmodule:: plotly.subplots
