Skip to content

Commit ac92b32

Browse files
emmanuelleemmanuelle
committed
api doc
1 parent d71fd6b commit ac92b32

File tree

10 files changed

+347
-0
lines changed

10 files changed

+347
-0
lines changed

‎apidoc/Makefile

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = .
8+
BUILDDIR = _build
9+
10+
# Put it first so that "make" without argument is like "make help".
11+
help:
12+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
13+
14+
.PHONY: help Makefile
15+
16+
# Catch-all target: route all unknown targets to Sphinx using the new
17+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
18+
%: Makefile
19+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎apidoc/README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
make html

‎apidoc/colors.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Colors
2+
======
3+
4+
.. currentmodule:: plotly.colors
5+
6+
.. autosummary::
7+
8+
make_colorscale
9+
10+
.. automodule:: plotly.colors
11+
:members:
12+

‎apidoc/conf.py

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# -*- coding: utf-8 -*-
2+
#
3+
# Configuration file for the Sphinx documentation builder.
4+
#
5+
# This file does only contain a selection of the most common options. For a
6+
# full list see the documentation:
7+
# http://www.sphinx-doc.org/en/master/config
8+
9+
# -- Path setup --------------------------------------------------------------
10+
11+
# If extensions (or modules to document with autodoc) are in another directory,
12+
# add these directories to sys.path here. If the directory is relative to the
13+
# documentation root, use os.path.abspath to make it absolute, like shown here.
14+
#
15+
import os
16+
import sys
17+
18+
# sys.path.insert(0, os.path.abspath("../packages/python/plotly"))
19+
20+
21+
# -- Project information -----------------------------------------------------
22+
23+
project = "plotly"
24+
copyright = "2019, plotly team"
25+
author = "plotly team"
26+
27+
# The short X.Y version
28+
version = ""
29+
# The full version, including alpha/beta/rc tags
30+
release = "4.2"
31+
32+
33+
# -- General configuration ---------------------------------------------------
34+
35+
# If your documentation needs a minimal Sphinx version, state it here.
36+
#
37+
# needs_sphinx = '1.0'
38+
39+
# Add any Sphinx extension module names here, as strings. They can be
40+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
41+
# ones.
42+
extensions = [
43+
"sphinx.ext.autodoc",
44+
"sphinx.ext.autosummary",
45+
"sphinx.ext.intersphinx",
46+
"sphinx.ext.todo",
47+
"sphinx.ext.coverage",
48+
"sphinx.ext.napoleon",
49+
]
50+
51+
autosummary_generate = True
52+
53+
# Add any paths that contain templates here, relative to this directory.
54+
templates_path = ["_templates"]
55+
56+
# The suffix(es) of source filenames.
57+
# You can specify multiple suffix as a list of string:
58+
#
59+
source_suffix = [".rst", ".md"]
60+
# source_suffix = '.rst'
61+
62+
source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
63+
# The master toctree document.
64+
master_doc = "index"
65+
66+
# The language for content autogenerated by Sphinx. Refer to documentation
67+
# for a list of supported languages.
68+
#
69+
# This is also used if you do content translation via gettext catalogs.
70+
# Usually you set "language" from the command line for these cases.
71+
language = None
72+
73+
# List of patterns, relative to source directory, that match files and
74+
# directories to ignore when looking for source files.
75+
# This pattern also affects html_static_path and html_extra_path.
76+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
77+
78+
# The name of the Pygments (syntax highlighting) style to use.
79+
pygments_style = None
80+
81+
82+
# -- Options for HTML output -------------------------------------------------
83+
84+
# The theme to use for HTML and HTML Help pages. See the documentation for
85+
# a list of builtin themes.
86+
#
87+
html_theme = "alabaster"
88+
89+
# Theme options are theme-specific and customize the look and feel of a theme
90+
# further. For a list of options available for each theme, see the
91+
# documentation.
92+
#
93+
# html_theme_options = {}
94+
95+
# Add any paths that contain custom static files (such as style sheets) here,
96+
# relative to this directory. They are copied after the builtin static files,
97+
# so a file named "default.css" will overwrite the builtin "default.css".
98+
html_static_path = ["_static"]
99+
100+
# Custom sidebar templates, must be a dictionary that maps document names
101+
# to template names.
102+
#
103+
# The default sidebars (for documents that don't match any pattern) are
104+
# defined by theme itself. Builtin themes are using these templates by
105+
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
106+
# 'searchbox.html']``.
107+
#
108+
# html_sidebars = {}
109+
110+
111+
# -- Options for HTMLHelp output ---------------------------------------------
112+
113+
# Output file base name for HTML help builder.
114+
htmlhelp_basename = "plotlydoc"
115+
116+
117+
# -- Options for LaTeX output ------------------------------------------------
118+
119+
latex_elements = {
120+
# The paper size ('letterpaper' or 'a4paper').
121+
#
122+
# 'papersize': 'letterpaper',
123+
# The font size ('10pt', '11pt' or '12pt').
124+
#
125+
# 'pointsize': '10pt',
126+
# Additional stuff for the LaTeX preamble.
127+
#
128+
# 'preamble': '',
129+
# Latex figure (float) alignment
130+
#
131+
# 'figure_align': 'htbp',
132+
}
133+
134+
# Grouping the document tree into LaTeX files. List of tuples
135+
# (source start file, target name, title,
136+
# author, documentclass [howto, manual, or own class]).
137+
latex_documents = [
138+
(master_doc, "plotly.tex", "plotly Documentation", "plotly team", "manual")
139+
]
140+
141+
142+
# -- Options for manual page output ------------------------------------------
143+
144+
# One entry per manual page. List of tuples
145+
# (source start file, name, description, authors, manual section).
146+
man_pages = [(master_doc, "plotly", "plotly Documentation", [author], 1)]
147+
148+
149+
# -- Options for Texinfo output ----------------------------------------------
150+
151+
# Grouping the document tree into Texinfo files. List of tuples
152+
# (source start file, target name, title, author,
153+
# dir menu entry, description, category)
154+
texinfo_documents = [
155+
(
156+
master_doc,
157+
"plotly",
158+
"plotly Documentation",
159+
author,
160+
"plotly",
161+
"One line description of project.",
162+
"Miscellaneous",
163+
)
164+
]
165+
166+
167+
# -- Options for Epub output -------------------------------------------------
168+
169+
# Bibliographic Dublin Core info.
170+
epub_title = project
171+
172+
# The unique identifier of the text. This can be a ISBN number
173+
# or the project homepage.
174+
#
175+
# epub_identifier = ''
176+
177+
# A unique identification for the text.
178+
#
179+
# epub_uid = ''
180+
181+
# A list of files that should not be packed into the epub file.
182+
epub_exclude_files = ["search.html"]
183+
184+
185+
# -- Extension configuration -------------------------------------------------
186+
187+
# -- Options for intersphinx extension ---------------------------------------
188+
189+
# Example configuration for intersphinx: refer to the Python standard library.
190+
intersphinx_mapping = {"https://docs.python.org/": None}
191+
192+
# -- Options for todo extension ----------------------------------------------
193+
194+
# If true, `todo` and `todoList` produce output, else they produce nothing.
195+
todo_include_todos = True

‎apidoc/figure_factory.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Figure Factory
2+
==============
3+
4+
.. currentmodule:: plotly.figure_factory
5+
6+
.. autosummary::
7+
8+
create_2d_density
9+
create_annotated_heatmap
10+
create_bullet
11+
create_candlestick
12+
create_dendrogram
13+
create_distplot
14+
create_facet_grid
15+
create_gantt
16+
create_ohlc
17+
create_quiver
18+
create_scatterplotmatrix
19+
create_streamline
20+
create_table
21+
create_ternary_contour
22+
create_trisurf
23+
create_violin
24+
25+
.. automodule:: plotly.figure_factory
26+
:members:
27+

‎apidoc/graph_objects.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GO
2+
===
3+
4+
.. automodule:: plotly.graph_objects
5+
:members:
6+

‎apidoc/index.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. plotly documentation master file, created by
2+
sphinx-quickstart on Wed Oct 2 12:55:48 2019.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to plotly's documentation!
7+
==================================
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
:caption: Contents:
12+
13+
px.rst
14+
graph_objects.rst
15+
figure_factory.rst
16+
io.rst
17+
colors.rst
18+
19+
20+
21+
Indices and tables
22+
==================
23+
24+
* :ref:`genindex`
25+
* :ref:`modindex`
26+
* :ref:`search`

‎apidoc/io.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
I/O
2+
==============
3+
4+
.. currentmodule:: plotly.io
5+
6+
.. autosummary::
7+
8+
to_image
9+
write_image
10+
to_json
11+
from_json
12+
read_json
13+
write_json
14+
templates
15+
to_templated
16+
to_html
17+
write_html
18+
renderers
19+
show
20+
21+
.. automodule:: plotly.io
22+
:members:
23+

‎apidoc/px.rst

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Plotly express
2+
==============
3+
4+
.. currentmodule:: plotly.express
5+
6+
.. autosummary::
7+
scatter
8+
scatter_3d
9+
scatter_polar
10+
scatter_ternary
11+
scatter_mapbox
12+
scatter_geo
13+
line
14+
line_3d
15+
line_polar
16+
line_ternary
17+
line_mapbox
18+
line_geo
19+
area
20+
bar
21+
bar_polar
22+
violin
23+
box
24+
strip
25+
histogram
26+
scatter_matrix
27+
parallel_coordinates
28+
parallel_categories
29+
choropleth
30+
density_contour
31+
density_heatmap
32+
33+
34+
.. automodule:: plotly.express
35+
:members:
36+

‎requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ requests
1717
networkx
1818
squarify
1919
scikit-image
20+
sphinx
21+
recommonmark

0 commit comments

Comments
 (0)