Skip to content

tweaks to look and feel of autodoc #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

tweaks to look and feel of autodoc #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions apidoc/_static/plotly-style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
4 changes: 2 additions & 2 deletions apidoc/figure_factory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _ff:

Figure Factory
`plotly.figure_factory`: helper methods for building specific complex charts
==============

.. currentmodule:: plotly.figure_factory
Expand All @@ -23,6 +23,6 @@ Figure Factory
create_streamline
create_table
create_ternary_contour
create_trisurf
create_trisurf
create_violin

12 changes: 7 additions & 5 deletions apidoc/graph_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emmanuelle is this the line that's preventing the Figure methods from appearing? should we have a Figure-specific template that makes them appear so we can keep the rest of this formatting in place?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'm working on it, can I push a commit directly to your branch? We need the template to include the members and inherited-members (which was done in the figure.rst file).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, and yes, feel free to push to this branch!


Figure

Layout
------
Expand Down
12 changes: 6 additions & 6 deletions apidoc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_.
Expand All @@ -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
-------------------
Expand Down
2 changes: 1 addition & 1 deletion apidoc/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _io:

I/O
`plotly.io`: low-level interface for displaying, reading and writing figures
==============

.. currentmodule:: plotly.io
Expand Down
2 changes: 1 addition & 1 deletion apidoc/px.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion apidoc/subplots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. _subplots:

Subplots: `plotly.subplots`
`plotly.subplots`: helper function for layout out multi-plot figures
===========================

.. currentmodule:: plotly.subplots
Expand Down