Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Autodoc style bis#188

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.

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

Already on GitHub?Sign in to your account

Merged
nicolaskruchten merged 5 commits intomasterfromautodoc_style_bis
Nov 11, 2019
Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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 deletionsapidoc/_static/plotly-style.css
View file
Open in desktop
Original file line numberDiff line numberDiff 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;
}
26 changes: 15 additions & 11 deletionsapidoc/_templates/class_figure.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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>

4 changes: 2 additions & 2 deletionsapidoc/_templates/trace.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
:mod:`{{module}}`.{{objname}}
{{ underline }}
{{ underline }}============================


.. currentmodule:: {{ module }}
Expand All@@ -12,7 +12,7 @@


:mod:`{{module}}`.{{objname.lower()}}
{{ underline }}
{{ underline }}================================

.. autosummary::

Expand Down
21 changes: 0 additions & 21 deletionsapidoc/figure.rst
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletionsapidoc/figure_factory.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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

13 changes: 8 additions & 5 deletionsapidoc/graph_objects.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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,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
Expand Down
12 changes: 6 additions & 6 deletionsapidoc/index.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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:`Plotlyexpress <px>`
* :ref:`Graphobjects: figures, traces and layout <graph-objects>`
* :ref:`Subplots <subplots>`
* :ref:`FigureFactory <ff>`
* :ref:`I/O <io>`
* :ref:`PlotlyExpress: high-level interface for data visualization <px>`
* :ref:`GraphObjects: low-level interface to figures, traces and layout <graph-objects>`
* :ref:`Subplots: helper function for layout out multi-plot figures <subplots>`
* :ref:`FigureFactories: 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 deletionapidoc/io.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionapidoc/px.rst
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionapidoc/subplots.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
.. _subplots:

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

.. currentmodule:: plotly.subplots
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp