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

Commit4d2d88c

Browse files
Merge pull request#188 from plotly/autodoc_style_bis
Autodoc style bis
2 parentse5bafb7 +c31ef55 commit4d2d88c

File tree

10 files changed

+52
-50
lines changed

10 files changed

+52
-50
lines changed

‎apidoc/_static/plotly-style.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,19 @@
1111
.body {
1212
font-family:"Open Sans", sans-serif;
1313
}
14+
.navbar-brandimg {
15+
height:30px;
16+
margin-top:4px;
17+
}
18+
19+
.navbar .container {
20+
padding-top:8px;
21+
}
22+
23+
a {
24+
color:#2391fe!important;
25+
}
26+
27+
code {
28+
color:#2391fe!important;
29+
}

‎apidoc/_templates/class_figure.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,28 @@
44

55
..currentmodule::{{ module }}
66

7-
..autoclass::{{ objname }}
7+
..autosummary::
8+
:toctree: generated/
9+
10+
Figure
811

12+
Figure.show
13+
Figure.add_traces
14+
Figure.update_traces
15+
Figure.update_layout
16+
17+
18+
..autoclass::{{ objname }}
919
{% block methods %}
1020
..automethod::__init__
11-
..automethod::show
12-
..automethod::update_layout
13-
..automethod::add_traces
1421
{% endblock %}
1522

16-
Other methods
17-
{{ underline }}==============
18-
19-
..autosummary::
20-
:toctree: generated/
21-
22-
plotly.graph_objects.{{ objname }}
2323

24+
..autoclass::{{ objname }}
25+
:members:
26+
:inherited-members:
2427

2528
..raw::html
2629

2730
<divclass="clearer"></div>
31+

‎apidoc/_templates/trace.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
:mod:`{{module}}`.{{objname}}
2-
{{ underline }}
2+
{{ underline }}============================
33

44

55
..currentmodule::{{ module }}
@@ -12,7 +12,7 @@
1212

1313

1414
:mod:`{{module}}`.{{objname.lower()}}
15-
{{ underline }}
15+
{{ underline }}================================
1616

1717
..autosummary::
1818

‎apidoc/figure.rst

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎apidoc/figure_factory.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _ff:
22

3-
Figure Factory
3+
`plotly.figure_factory`: helper methods for building specific complex charts
44
==============
55

66
..currentmodule::plotly.figure_factory
@@ -23,6 +23,6 @@ Figure Factory
2323
create_streamline
2424
create_table
2525
create_ternary_contour
26-
create_trisurf
26+
create_trisurf
2727
create_violin
2828

‎apidoc/graph_objects.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _graph-objects:
22

3-
Graph objects: figures, traces and layout
3+
`plotly.graph_objects`: low-level interface to figures, traces and layout
44
=========================================
55

66
..currentmodule::plotly.graph_objects
@@ -11,11 +11,14 @@ Graph objects: figures, traces and layout
1111

1212
>>> import plotly.graph_objects as go
1313

14-
..toctree::
15-
:maxdepth:1
16-
:caption:Figure:
14+
Figure
15+
------
16+
17+
..autosummary::
18+
:toctree: generated/
19+
:template: class_figure.rst
1720

18-
figure.rst
21+
Figure
1922

2023

2124
Layout

‎apidoc/index.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
plotly API reference
6+
Python API reference for `plotly`
77
====================
88

99
This is the reference of plotly's API. Also see `plotly's documentation website<https://plot.ly/python>`_.
@@ -12,11 +12,11 @@ Submodules
1212
----------
1313

1414

15-
*:ref:`Plotlyexpress<px>`
16-
*:ref:`Graphobjects: figures, traces and layout<graph-objects>`
17-
*:ref:`Subplots<subplots>`
18-
*:ref:`FigureFactory<ff>`
19-
*:ref:`I/O<io>`
15+
*:ref:`PlotlyExpress: high-level interface for data visualization<px>`
16+
*:ref:`GraphObjects: low-level interface to figures, traces and layout<graph-objects>`
17+
*:ref:`Subplots: helper function for layout out multi-plot figures<subplots>`
18+
*:ref:`FigureFactories: helper methods for building specific complex charts<ff>`
19+
*:ref:`I/O: low-level interface for displaying, reading and writing figures<io>`
2020

2121
Full reference list
2222
-------------------

‎apidoc/io.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _io:
22

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

66
..currentmodule::plotly.io

‎apidoc/px.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _px:
22

3-
Plotly express:`plotly.express`
3+
`plotly.express`: high-level interface for data visualization
44
================================
55

66
The `plotly.express<https://plot.ly/python/plotly-express/>`_ module is

‎apidoc/subplots.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _subplots:
22

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

66
..currentmodule::plotly.subplots

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp