From 2dc791eba924b1249a1fa1e83789d5de2654f56c Mon Sep 17 00:00:00 2001 From: Nicolas Kruchten Date: Sun, 10 Nov 2019 13:56:23 -0500 Subject: [PATCH] tweaks to look and feel of autodoc --- apidoc/_static/plotly-style.css | 16 ++++++++++++++++ apidoc/figure_factory.rst | 4 ++-- apidoc/graph_objects.rst | 12 +++++++----- apidoc/index.rst | 12 ++++++------ apidoc/io.rst | 2 +- apidoc/px.rst | 2 +- apidoc/subplots.rst | 2 +- 7 files changed, 34 insertions(+), 16 deletions(-) diff --git a/apidoc/_static/plotly-style.css b/apidoc/_static/plotly-style.css index 2163d78c9..3aa07cd68 100644 --- 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/figure_factory.rst b/apidoc/figure_factory.rst index 94aefb7c7..09b01b1a3 100644 --- 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 index 525f9dedd..c1a4a7357 100644 --- 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,12 +11,14 @@ Graph objects: figures, traces and layout >>> import plotly.graph_objects as go -.. toctree:: - :maxdepth: 1 - :caption: Figure: +Figure +------ - figure.rst +.. autosummary:: + :toctree: generated/ + :template: trace.rst + Figure Layout ------ diff --git a/apidoc/index.rst b/apidoc/index.rst index c2a7d787d..463752036 100644 --- 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 `_. @@ -12,11 +12,11 @@ Submodules ---------- -* :ref:`Plotly express ` -* :ref:`Graph objects: figures, traces and layout ` -* :ref:`Subplots ` -* :ref:`Figure Factory ` -* :ref:`I/O ` +* :ref:`Plotly Express: high-level interface for data visualization ` +* :ref:`Graph Objects: low-level interface to figures, traces and layout ` +* :ref:`Subplots: helper function for layout out multi-plot figures ` +* :ref:`Figure Factories: helper methods for building specific complex charts ` +* :ref:`I/O: low-level interface for displaying, reading and writing figures ` Full reference list ------------------- diff --git a/apidoc/io.rst b/apidoc/io.rst index 296a77d5e..3fe4c0f2b 100644 --- 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 index 7873c72fc..45bccb7d1 100644 --- 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 `_ module is diff --git a/apidoc/subplots.rst b/apidoc/subplots.rst index dbacf971b..1a7699c11 100644 --- a/apidoc/subplots.rst +++ b/apidoc/subplots.rst @@ -1,6 +1,6 @@ .. _subplots: -Subplots: `plotly.subplots` +`plotly.subplots`: helper function for layout out multi-plot figures =========================== .. currentmodule:: plotly.subplots