From ac92b32199bbd10387a99351358ff8c7c71e6618 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Fri, 4 Oct 2019 22:04:37 -0400 Subject: [PATCH 01/14] api doc --- apidoc/Makefile | 19 ++++ apidoc/README.rst | 1 + apidoc/colors.rst | 12 +++ apidoc/conf.py | 195 ++++++++++++++++++++++++++++++++++++++ apidoc/figure_factory.rst | 27 ++++++ apidoc/graph_objects.rst | 6 ++ apidoc/index.rst | 26 +++++ apidoc/io.rst | 23 +++++ apidoc/px.rst | 36 +++++++ requirements.txt | 2 + 10 files changed, 347 insertions(+) create mode 100644 apidoc/Makefile create mode 100644 apidoc/README.rst create mode 100644 apidoc/colors.rst create mode 100644 apidoc/conf.py create mode 100644 apidoc/figure_factory.rst create mode 100644 apidoc/graph_objects.rst create mode 100644 apidoc/index.rst create mode 100644 apidoc/io.rst create mode 100644 apidoc/px.rst diff --git a/apidoc/Makefile b/apidoc/Makefile new file mode 100644 index 000000000..298ea9e21 --- /dev/null +++ b/apidoc/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/apidoc/README.rst b/apidoc/README.rst new file mode 100644 index 000000000..d210288c6 --- /dev/null +++ b/apidoc/README.rst @@ -0,0 +1 @@ +make html diff --git a/apidoc/colors.rst b/apidoc/colors.rst new file mode 100644 index 000000000..50b9edd42 --- /dev/null +++ b/apidoc/colors.rst @@ -0,0 +1,12 @@ +Colors +====== + +.. currentmodule:: plotly.colors + +.. autosummary:: + + make_colorscale + +.. automodule:: plotly.colors + :members: + diff --git a/apidoc/conf.py b/apidoc/conf.py new file mode 100644 index 000000000..50e121f8f --- /dev/null +++ b/apidoc/conf.py @@ -0,0 +1,195 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +# sys.path.insert(0, os.path.abspath("../packages/python/plotly")) + + +# -- Project information ----------------------------------------------------- + +project = "plotly" +copyright = "2019, plotly team" +author = "plotly team" + +# The short X.Y version +version = "" +# The full version, including alpha/beta/rc tags +release = "4.2" + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.todo", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", +] + +autosummary_generate = True + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = [".rst", ".md"] +# source_suffix = '.rst' + +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} +# The master toctree document. +master_doc = "index" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "plotlydoc" + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, "plotly.tex", "plotly Documentation", "plotly team", "manual") +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "plotly", "plotly Documentation", [author], 1)] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + "plotly", + "plotly Documentation", + author, + "plotly", + "One line description of project.", + "Miscellaneous", + ) +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ["search.html"] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {"https://docs.python.org/": None} + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/apidoc/figure_factory.rst b/apidoc/figure_factory.rst new file mode 100644 index 000000000..a2aaf1693 --- /dev/null +++ b/apidoc/figure_factory.rst @@ -0,0 +1,27 @@ +Figure Factory +============== + +.. currentmodule:: plotly.figure_factory + +.. autosummary:: + + create_2d_density + create_annotated_heatmap + create_bullet + create_candlestick + create_dendrogram + create_distplot + create_facet_grid + create_gantt + create_ohlc + create_quiver + create_scatterplotmatrix + create_streamline + create_table + create_ternary_contour + create_trisurf + create_violin + +.. automodule:: plotly.figure_factory + :members: + diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst new file mode 100644 index 000000000..daf47ba27 --- /dev/null +++ b/apidoc/graph_objects.rst @@ -0,0 +1,6 @@ +GO +=== + +.. automodule:: plotly.graph_objects + :members: + diff --git a/apidoc/index.rst b/apidoc/index.rst new file mode 100644 index 000000000..35bb53ba9 --- /dev/null +++ b/apidoc/index.rst @@ -0,0 +1,26 @@ +.. plotly documentation master file, created by + sphinx-quickstart on Wed Oct 2 12:55:48 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to plotly's documentation! +================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + px.rst + graph_objects.rst + figure_factory.rst + io.rst + colors.rst + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/apidoc/io.rst b/apidoc/io.rst new file mode 100644 index 000000000..975c09b9f --- /dev/null +++ b/apidoc/io.rst @@ -0,0 +1,23 @@ +I/O +============== + +.. currentmodule:: plotly.io + +.. autosummary:: + + to_image + write_image + to_json + from_json + read_json + write_json + templates + to_templated + to_html + write_html + renderers + show + +.. automodule:: plotly.io + :members: + diff --git a/apidoc/px.rst b/apidoc/px.rst new file mode 100644 index 000000000..785560a09 --- /dev/null +++ b/apidoc/px.rst @@ -0,0 +1,36 @@ +Plotly express +============== + +.. currentmodule:: plotly.express + +.. autosummary:: + scatter + scatter_3d + scatter_polar + scatter_ternary + scatter_mapbox + scatter_geo + line + line_3d + line_polar + line_ternary + line_mapbox + line_geo + area + bar + bar_polar + violin + box + strip + histogram + scatter_matrix + parallel_coordinates + parallel_categories + choropleth + density_contour + density_heatmap + + +.. automodule:: plotly.express + :members: + diff --git a/requirements.txt b/requirements.txt index d701fb73f..9b801efa7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -17,3 +17,5 @@ requests networkx squarify scikit-image +sphinx +recommonmark From 7efe514046671c6a3979cef2a7391761a4c8ff27 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Sun, 6 Oct 2019 18:59:18 -0400 Subject: [PATCH 02/14] graph objects names, submodules --- apidoc/graph_objects.rst | 252 +++++++++++++++++++++++++++++++++++++- apidoc/helper_go_names.py | 34 +++++ 2 files changed, 284 insertions(+), 2 deletions(-) create mode 100644 apidoc/helper_go_names.py diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst index daf47ba27..7d78cb4f8 100644 --- a/apidoc/graph_objects.rst +++ b/apidoc/graph_objects.rst @@ -1,6 +1,254 @@ -GO -=== +Graph objects: figures, traces and layout +========================================= + +.. currentmodule:: plotly.graph_objects + +Classes + +.. autosummary:: + + Area + Bar + Barpolar + Box + Candlestick + Carpet + Choropleth + Choroplethmapbox + Cone + Contour + Contourcarpet + Densitymapbox + Figure + FigureWidget + Frame + Funnel + Funnelarea + Heatmap + Heatmapgl + Histogram + Histogram2d + Histogram2dContour + Indicator + Isosurface + Layout + Mesh3d + Ohlc + Parcats + Parcoords + Pie + Pointcloud + Sankey + Scatter + Scatter3d + Scattercarpet + Scattergeo + Scattergl + Scattermapbox + Scatterpolar + Scatterpolargl + Scatterternary + Splom + Streamtube + Sunburst + Surface + Table + Violin + Volume + Waterfall + + +Submodules + + +.. autosummary:: + + area + bar + barpolar + box + candlestick + carpet + choropleth + choroplethmapbox + cone + contour + contourcarpet + densitymapbox + funnel + funnelarea + heatmap + heatmapgl + histogram + histogram2d + histogram2dcontour + indicator + isosurface + layout + mesh3d + ohlc + parcats + parcoords + pie + pointcloud + sankey + scatter + scatter3d + scattercarpet + scattergeo + scattergl + scattermapbox + scatterpolar + scatterpolargl + scatterternary + splom + streamtube + sunburst + surface + table + violin + volume + waterfall + .. automodule:: plotly.graph_objects :members: +.. automodule:: plotly.graph_objects.area + :members: + +.. automodule:: plotly.graph_objects.bar + :members: + +.. automodule:: plotly.graph_objects.barpolar + :members: + +.. automodule:: plotly.graph_objects.box + :members: + +.. automodule:: plotly.graph_objects.candlestick + :members: + +.. automodule:: plotly.graph_objects.carpet + :members: + +.. automodule:: plotly.graph_objects.choropleth + :members: + +.. automodule:: plotly.graph_objects.choroplethmapbox + :members: + +.. automodule:: plotly.graph_objects.cone + :members: + +.. automodule:: plotly.graph_objects.contour + :members: + +.. automodule:: plotly.graph_objects.contourcarpet + :members: + +.. automodule:: plotly.graph_objects.densitymapbox + :members: + +.. automodule:: plotly.graph_objects.funnel + :members: + +.. automodule:: plotly.graph_objects.funnelarea + :members: + +.. automodule:: plotly.graph_objects.heatmap + :members: + +.. automodule:: plotly.graph_objects.heatmapgl + :members: + +.. automodule:: plotly.graph_objects.histogram + :members: + +.. automodule:: plotly.graph_objects.histogram2d + :members: + +.. automodule:: plotly.graph_objects.histogram2dcontour + :members: + +.. automodule:: plotly.graph_objects.indicator + :members: + +.. automodule:: plotly.graph_objects.isosurface + :members: + +.. automodule:: plotly.graph_objects.layout + :members: + +.. automodule:: plotly.graph_objects.mesh3d + :members: + +.. automodule:: plotly.graph_objects.ohlc + :members: + +.. automodule:: plotly.graph_objects.parcats + :members: + +.. automodule:: plotly.graph_objects.parcoords + :members: + +.. automodule:: plotly.graph_objects.pie + :members: + +.. automodule:: plotly.graph_objects.pointcloud + :members: + +.. automodule:: plotly.graph_objects.sankey + :members: + +.. automodule:: plotly.graph_objects.scatter + :members: + +.. automodule:: plotly.graph_objects.scatter3d + :members: + +.. automodule:: plotly.graph_objects.scattercarpet + :members: + +.. automodule:: plotly.graph_objects.scattergeo + :members: + +.. automodule:: plotly.graph_objects.scattergl + :members: + +.. automodule:: plotly.graph_objects.scattermapbox + :members: + +.. automodule:: plotly.graph_objects.scatterpolar + :members: + +.. automodule:: plotly.graph_objects.scatterpolargl + :members: + +.. automodule:: plotly.graph_objects.scatterternary + :members: + +.. automodule:: plotly.graph_objects.splom + :members: + +.. automodule:: plotly.graph_objects.streamtube + :members: + +.. automodule:: plotly.graph_objects.sunburst + :members: + +.. automodule:: plotly.graph_objects.surface + :members: + +.. automodule:: plotly.graph_objects.table + :members: + +.. automodule:: plotly.graph_objects.violin + :members: + +.. automodule:: plotly.graph_objects.volume + :members: + +.. automodule:: plotly.graph_objects.waterfall + :members: + diff --git a/apidoc/helper_go_names.py b/apidoc/helper_go_names.py new file mode 100644 index 000000000..0a5621023 --- /dev/null +++ b/apidoc/helper_go_names.py @@ -0,0 +1,34 @@ +import inspect +import plotly.graph_objects as go + +members = inspect.getmembers(go) + +functions, classes, submodules = [], [], [] + +for m in members: + print(m) + if m[0] not in go.__all__: + continue + if m[1].__doc__ and 'is deprecated' in m[1].__doc__: + continue + elif inspect.isfunction(m[1]): + functions.append(m[0]) + elif inspect.isclass(m[1]): + classes.append(m[0]) + elif inspect.ismodule(m[1]): + submodules.append(m[0]) + +classes.sort() +submodules.sort() + +classes_str = "\n".join(classes) +# print(classes_str) + +submodules_str = "\n".join(submodules) +# print(submodules_str) + +autosubmodule = '' + +for submodule in submodules: + autosubmodule += '.. automodule:: plotly.graph_objects.%s\n :members:\n\n' %submodule +print(autosubmodule) From 9e80bfa8f2a19aeb2334c0bc52516d1667381024 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 8 Oct 2019 17:17:43 -0400 Subject: [PATCH 03/14] build doc in circle --- .circleci/config.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 7028edb05..c47a7cbbc 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -68,6 +68,13 @@ jobs: tar -zcf build/html.tgz build/html rm -rf build/html build/ipynb + - run: + name: make doc + command: | + cd apidoc + make html + cd .. + - store_artifacts: path: build From 04dfb4cfdc1aa3e0192cd518b9f0bfa9975f805e Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 8 Oct 2019 21:47:48 -0400 Subject: [PATCH 04/14] sphinx-build workaround --- apidoc/Makefile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/apidoc/Makefile b/apidoc/Makefile index 298ea9e21..04e1852fb 100644 --- a/apidoc/Makefile +++ b/apidoc/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXBUILD = python -m sphinx SOURCEDIR = . BUILDDIR = _build @@ -16,4 +16,4 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) From 2275e40cfa9318db74f8894b3e0502de2eae3ffc Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 8 Oct 2019 21:53:53 -0400 Subject: [PATCH 05/14] sphinx and venv --- .circleci/config.yml | 1 + apidoc/Makefile | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index c47a7cbbc..93eb642e7 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -71,6 +71,7 @@ jobs: - run: name: make doc command: | + . venv/bin/activate cd apidoc make html cd .. diff --git a/apidoc/Makefile b/apidoc/Makefile index 04e1852fb..8b64b1e99 100644 --- a/apidoc/Makefile +++ b/apidoc/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = python -m sphinx +SPHINXBUILD = python3 -m sphinx SOURCEDIR = . BUILDDIR = _build From 07826380d920fd0c8b655e3e9716d29cd43c93ce Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 8 Oct 2019 22:02:51 -0400 Subject: [PATCH 06/14] artifact --- .circleci/config.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 93eb642e7..785023bcf 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -80,3 +80,8 @@ jobs: - store_artifacts: path: build destination: build + + + - store_artifacts: + path: apidoc/_build/html + destination: apidoc From c600541fc220a35ceda5ef36495bb29c70fb9b2d Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Tue, 8 Oct 2019 23:00:19 -0400 Subject: [PATCH 07/14] added subplots + a few sentences --- apidoc/graph_objects.rst | 7 +++++++ apidoc/index.rst | 7 +++++-- apidoc/px.rst | 9 +++++++-- apidoc/subplots.rst | 12 ++++++++++++ 4 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 apidoc/subplots.rst diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst index 7d78cb4f8..8f249547c 100644 --- a/apidoc/graph_objects.rst +++ b/apidoc/graph_objects.rst @@ -3,6 +3,13 @@ Graph objects: figures, traces and layout .. currentmodule:: plotly.graph_objects +:mod:`plotly.graph_objects` contains the building blocks of plotly :class:`Figure`: traces +(:class:`Scatter`, :class:`Bar`, ...) and :class:`Layout` +:: + + >>> import plotly.graph_objects as go + + Classes .. autosummary:: diff --git a/apidoc/index.rst b/apidoc/index.rst index 35bb53ba9..55c48a637 100644 --- a/apidoc/index.rst +++ b/apidoc/index.rst @@ -3,8 +3,10 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to plotly's documentation! -================================== +plotly API reference +==================== + +This is the reference of plotly's API. Also see `plotly's documentation website `_. .. toctree:: :maxdepth: 2 @@ -12,6 +14,7 @@ Welcome to plotly's documentation! px.rst graph_objects.rst + subplots.rst figure_factory.rst io.rst colors.rst diff --git a/apidoc/px.rst b/apidoc/px.rst index 785560a09..500dc7476 100644 --- a/apidoc/px.rst +++ b/apidoc/px.rst @@ -1,5 +1,10 @@ -Plotly express -============== +Plotly express: `plotly.express` +================================ + +The `plotly.express `_ module is +plotly's high-level API for rapid figure generation. :: + + >>> import plotly.express as px .. currentmodule:: plotly.express diff --git a/apidoc/subplots.rst b/apidoc/subplots.rst new file mode 100644 index 000000000..ad4e7fc25 --- /dev/null +++ b/apidoc/subplots.rst @@ -0,0 +1,12 @@ +Subplots: `plotly.subplots` +=========================== + +.. currentmodule:: plotly.subplots + +.. autosummary:: + + make_subplots + + +.. autofunction:: plotly.subplots.make_subplots + From 0eeed727485f4724ab8c0af610ddbe6b17a4f5dc Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Wed, 9 Oct 2019 22:46:49 -0400 Subject: [PATCH 08/14] build doc from master --- .circleci/config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 785023bcf..c3382d674 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -72,6 +72,7 @@ jobs: name: make doc command: | . venv/bin/activate + pip install git+https://github.com/plotly/plotly.py#egg=plotly.py cd apidoc make html cd .. From a12ed86e29a8a9a6e61bba6eb7ba25f8c2917c73 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 10 Oct 2019 09:56:01 -0400 Subject: [PATCH 09/14] CI --- .circleci/config.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index c3382d674..51640a785 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -72,10 +72,13 @@ jobs: name: make doc command: | . venv/bin/activate - pip install git+https://github.com/plotly/plotly.py#egg=plotly.py - cd apidoc + git clone https://github.com/plotly/plotly.py.git plotly-master + cd plotly-master/packages/python/plotly + pip install -e . + cd ../../../../apidoc make html cd .. + rm -rf plotly-master - store_artifacts: From 61d66560d8efb5a9557e7f4671034640687767ec Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Wed, 16 Oct 2019 10:13:19 -0400 Subject: [PATCH 10/14] one page of doc per function of class --- apidoc/_templates/class.rst | 15 +++ apidoc/_templates/class_figure.rst | 22 ++++ apidoc/_templates/function.rst | 11 ++ apidoc/figure_factory.rst | 5 +- apidoc/graph_objects.rst | 151 ++------------------- apidoc/graph_objects_submodules.rst | 195 ++++++++++++++++++++++++++++ apidoc/io.rst | 2 + apidoc/px.rst | 5 +- apidoc/subplots.rst | 2 + 9 files changed, 260 insertions(+), 148 deletions(-) create mode 100644 apidoc/_templates/class.rst create mode 100644 apidoc/_templates/class_figure.rst create mode 100644 apidoc/_templates/function.rst create mode 100644 apidoc/graph_objects_submodules.rst diff --git a/apidoc/_templates/class.rst b/apidoc/_templates/class.rst new file mode 100644 index 000000000..494293e1c --- /dev/null +++ b/apidoc/_templates/class.rst @@ -0,0 +1,15 @@ +:mod:`{{module}}`.{{objname}} +{{ underline }}============== + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + + {% block methods %} + .. automethod:: __init__ + {% endblock %} + + +.. raw:: html + +
diff --git a/apidoc/_templates/class_figure.rst b/apidoc/_templates/class_figure.rst new file mode 100644 index 000000000..d9f011f43 --- /dev/null +++ b/apidoc/_templates/class_figure.rst @@ -0,0 +1,22 @@ +:mod:`{{module}}`.{{objname}} +{{ underline }}============== + +Hello this is my template + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :inherited-members: update_layout + :members: update_layout, add_traces + + {% block methods %} + .. automethod:: __init__ + .. automethod:: add_bar + .. automethod:: update_layout + .. automethod:: add_traces + {% endblock %} + + +.. raw:: html + +
diff --git a/apidoc/_templates/function.rst b/apidoc/_templates/function.rst new file mode 100644 index 000000000..b81cd41a9 --- /dev/null +++ b/apidoc/_templates/function.rst @@ -0,0 +1,11 @@ +:mod:`{{module}}`.{{objname}} +{{ underline }}==================== + +.. currentmodule:: {{ module }} + +.. autofunction:: {{ objname }} + + +.. raw:: html + +
diff --git a/apidoc/figure_factory.rst b/apidoc/figure_factory.rst index a2aaf1693..3dc42596a 100644 --- a/apidoc/figure_factory.rst +++ b/apidoc/figure_factory.rst @@ -4,6 +4,8 @@ Figure Factory .. currentmodule:: plotly.figure_factory .. autosummary:: + :toctree: generated/ + :template: function.rst create_2d_density create_annotated_heatmap @@ -22,6 +24,3 @@ Figure Factory create_trisurf create_violin -.. automodule:: plotly.figure_factory - :members: - diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst index 8f249547c..eabec64f4 100644 --- a/apidoc/graph_objects.rst +++ b/apidoc/graph_objects.rst @@ -13,6 +13,14 @@ Graph objects: figures, traces and layout Classes .. autosummary:: + :toctree: generated/ + :template: class_figure.rst + + Figure + +.. autosummary:: + :toctree: generated/ + :template: class.rst Area Bar @@ -26,7 +34,6 @@ Classes Contour Contourcarpet Densitymapbox - Figure FigureWidget Frame Funnel @@ -117,145 +124,3 @@ Submodules volume waterfall - -.. automodule:: plotly.graph_objects - :members: - -.. automodule:: plotly.graph_objects.area - :members: - -.. automodule:: plotly.graph_objects.bar - :members: - -.. automodule:: plotly.graph_objects.barpolar - :members: - -.. automodule:: plotly.graph_objects.box - :members: - -.. automodule:: plotly.graph_objects.candlestick - :members: - -.. automodule:: plotly.graph_objects.carpet - :members: - -.. automodule:: plotly.graph_objects.choropleth - :members: - -.. automodule:: plotly.graph_objects.choroplethmapbox - :members: - -.. automodule:: plotly.graph_objects.cone - :members: - -.. automodule:: plotly.graph_objects.contour - :members: - -.. automodule:: plotly.graph_objects.contourcarpet - :members: - -.. automodule:: plotly.graph_objects.densitymapbox - :members: - -.. automodule:: plotly.graph_objects.funnel - :members: - -.. automodule:: plotly.graph_objects.funnelarea - :members: - -.. automodule:: plotly.graph_objects.heatmap - :members: - -.. automodule:: plotly.graph_objects.heatmapgl - :members: - -.. automodule:: plotly.graph_objects.histogram - :members: - -.. automodule:: plotly.graph_objects.histogram2d - :members: - -.. automodule:: plotly.graph_objects.histogram2dcontour - :members: - -.. automodule:: plotly.graph_objects.indicator - :members: - -.. automodule:: plotly.graph_objects.isosurface - :members: - -.. automodule:: plotly.graph_objects.layout - :members: - -.. automodule:: plotly.graph_objects.mesh3d - :members: - -.. automodule:: plotly.graph_objects.ohlc - :members: - -.. automodule:: plotly.graph_objects.parcats - :members: - -.. automodule:: plotly.graph_objects.parcoords - :members: - -.. automodule:: plotly.graph_objects.pie - :members: - -.. automodule:: plotly.graph_objects.pointcloud - :members: - -.. automodule:: plotly.graph_objects.sankey - :members: - -.. automodule:: plotly.graph_objects.scatter - :members: - -.. automodule:: plotly.graph_objects.scatter3d - :members: - -.. automodule:: plotly.graph_objects.scattercarpet - :members: - -.. automodule:: plotly.graph_objects.scattergeo - :members: - -.. automodule:: plotly.graph_objects.scattergl - :members: - -.. automodule:: plotly.graph_objects.scattermapbox - :members: - -.. automodule:: plotly.graph_objects.scatterpolar - :members: - -.. automodule:: plotly.graph_objects.scatterpolargl - :members: - -.. automodule:: plotly.graph_objects.scatterternary - :members: - -.. automodule:: plotly.graph_objects.splom - :members: - -.. automodule:: plotly.graph_objects.streamtube - :members: - -.. automodule:: plotly.graph_objects.sunburst - :members: - -.. automodule:: plotly.graph_objects.surface - :members: - -.. automodule:: plotly.graph_objects.table - :members: - -.. automodule:: plotly.graph_objects.violin - :members: - -.. automodule:: plotly.graph_objects.volume - :members: - -.. automodule:: plotly.graph_objects.waterfall - :members: - diff --git a/apidoc/graph_objects_submodules.rst b/apidoc/graph_objects_submodules.rst new file mode 100644 index 000000000..49ddc1bb0 --- /dev/null +++ b/apidoc/graph_objects_submodules.rst @@ -0,0 +1,195 @@ +Graph objects submodules +======================== + +.. currentmodule:: plotly.graph_objects + + + +.. autosummary:: + + area + bar + barpolar + box + candlestick + carpet + choropleth + choroplethmapbox + cone + contour + contourcarpet + densitymapbox + funnel + funnelarea + heatmap + heatmapgl + histogram + histogram2d + histogram2dcontour + indicator + isosurface + layout + mesh3d + ohlc + parcats + parcoords + pie + pointcloud + sankey + scatter + scatter3d + scattercarpet + scattergeo + scattergl + scattermapbox + scatterpolar + scatterpolargl + scatterternary + splom + streamtube + sunburst + surface + table + violin + volume + waterfall + + +.. automodule:: plotly.graph_objects.area + :members: + +.. automodule:: plotly.graph_objects.bar + :members: + +.. automodule:: plotly.graph_objects.barpolar + :members: + +.. automodule:: plotly.graph_objects.box + :members: + +.. automodule:: plotly.graph_objects.candlestick + :members: + +.. automodule:: plotly.graph_objects.carpet + :members: + +.. automodule:: plotly.graph_objects.choropleth + :members: + +.. automodule:: plotly.graph_objects.choroplethmapbox + :members: + +.. automodule:: plotly.graph_objects.cone + :members: + +.. automodule:: plotly.graph_objects.contour + :members: + +.. automodule:: plotly.graph_objects.contourcarpet + :members: + +.. automodule:: plotly.graph_objects.densitymapbox + :members: + +.. automodule:: plotly.graph_objects.funnel + :members: + +.. automodule:: plotly.graph_objects.funnelarea + :members: + +.. automodule:: plotly.graph_objects.heatmap + :members: + +.. automodule:: plotly.graph_objects.heatmapgl + :members: + +.. automodule:: plotly.graph_objects.histogram + :members: + +.. automodule:: plotly.graph_objects.histogram2d + :members: + +.. automodule:: plotly.graph_objects.histogram2dcontour + :members: + +.. automodule:: plotly.graph_objects.indicator + :members: + +.. automodule:: plotly.graph_objects.isosurface + :members: + +.. automodule:: plotly.graph_objects.layout + :members: + +.. automodule:: plotly.graph_objects.mesh3d + :members: + +.. automodule:: plotly.graph_objects.ohlc + :members: + +.. automodule:: plotly.graph_objects.parcats + :members: + +.. automodule:: plotly.graph_objects.parcoords + :members: + +.. automodule:: plotly.graph_objects.pie + :members: + +.. automodule:: plotly.graph_objects.pointcloud + :members: + +.. automodule:: plotly.graph_objects.sankey + :members: + +.. automodule:: plotly.graph_objects.scatter + :members: + +.. automodule:: plotly.graph_objects.scatter3d + :members: + +.. automodule:: plotly.graph_objects.scattercarpet + :members: + +.. automodule:: plotly.graph_objects.scattergeo + :members: + +.. automodule:: plotly.graph_objects.scattergl + :members: + +.. automodule:: plotly.graph_objects.scattermapbox + :members: + +.. automodule:: plotly.graph_objects.scatterpolar + :members: + +.. automodule:: plotly.graph_objects.scatterpolargl + :members: + +.. automodule:: plotly.graph_objects.scatterternary + :members: + +.. automodule:: plotly.graph_objects.splom + :members: + +.. automodule:: plotly.graph_objects.streamtube + :members: + +.. automodule:: plotly.graph_objects.sunburst + :members: + +.. automodule:: plotly.graph_objects.surface + :members: + +.. automodule:: plotly.graph_objects.table + :members: + +.. automodule:: plotly.graph_objects.violin + :members: + +.. automodule:: plotly.graph_objects.volume + :members: + +.. automodule:: plotly.graph_objects.waterfall + :members: + diff --git a/apidoc/io.rst b/apidoc/io.rst index 975c09b9f..4745000c6 100644 --- a/apidoc/io.rst +++ b/apidoc/io.rst @@ -4,6 +4,8 @@ I/O .. currentmodule:: plotly.io .. autosummary:: + :toctree: generated/ + :template: function.rst to_image write_image diff --git a/apidoc/px.rst b/apidoc/px.rst index 500dc7476..87cb5a2a8 100644 --- a/apidoc/px.rst +++ b/apidoc/px.rst @@ -9,6 +9,9 @@ plotly's high-level API for rapid figure generation. :: .. currentmodule:: plotly.express .. autosummary:: + :toctree: generated/ + :template: function.rst + scatter scatter_3d scatter_polar @@ -36,6 +39,4 @@ plotly's high-level API for rapid figure generation. :: density_heatmap -.. automodule:: plotly.express - :members: diff --git a/apidoc/subplots.rst b/apidoc/subplots.rst index ad4e7fc25..a29ed0c67 100644 --- a/apidoc/subplots.rst +++ b/apidoc/subplots.rst @@ -4,6 +4,8 @@ Subplots: `plotly.subplots` .. currentmodule:: plotly.subplots .. autosummary:: + :toctree: generated/ + :template: function.rst make_subplots From 5c125404b829ba4e81497fe265507e6bc8a6a3ad Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 17 Oct 2019 14:28:06 -0400 Subject: [PATCH 11/14] better layout --- apidoc/_templates/class_figure.rst | 13 +- apidoc/_templates/trace.rst | 28 ++++ apidoc/colors.rst | 12 -- apidoc/conf.py | 8 +- apidoc/figure.rst | 17 +++ apidoc/graph_objects.rst | 177 ++++++++++++------------- apidoc/graph_objects_submodules.rst | 195 ---------------------------- apidoc/index.rst | 19 ++- 8 files changed, 162 insertions(+), 307 deletions(-) create mode 100644 apidoc/_templates/trace.rst delete mode 100644 apidoc/colors.rst create mode 100644 apidoc/figure.rst delete mode 100644 apidoc/graph_objects_submodules.rst diff --git a/apidoc/_templates/class_figure.rst b/apidoc/_templates/class_figure.rst index d9f011f43..b55f68b22 100644 --- a/apidoc/_templates/class_figure.rst +++ b/apidoc/_templates/class_figure.rst @@ -1,21 +1,26 @@ :mod:`{{module}}`.{{objname}} {{ underline }}============== -Hello this is my template .. currentmodule:: {{ module }} .. autoclass:: {{ objname }} - :inherited-members: update_layout - :members: update_layout, add_traces {% block methods %} .. automethod:: __init__ - .. automethod:: add_bar + .. automethod:: show .. automethod:: update_layout .. automethod:: add_traces {% endblock %} +Other methods +{{ underline }}============== + +.. autosummary:: + :toctree: generated/ + + plotly.graph_objects.{{ objname }} + .. raw:: html diff --git a/apidoc/_templates/trace.rst b/apidoc/_templates/trace.rst new file mode 100644 index 000000000..1fae91777 --- /dev/null +++ b/apidoc/_templates/trace.rst @@ -0,0 +1,28 @@ +:mod:`{{module}}`.{{objname}} +{{ underline }} + + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + + {% block methods %} + .. automethod:: __init__ + {% endblock %} + + +:mod:`{{module}}`.{{objname.lower()}} +{{ underline }} + +.. autosummary:: + :toctree: generated/ + + plotly.graph_objects.{{ objname.lower() }} + +.. automodule:: plotly.graph_objects.{{ objname.lower() }} + :members: + + +.. raw:: html + +
diff --git a/apidoc/colors.rst b/apidoc/colors.rst deleted file mode 100644 index 50b9edd42..000000000 --- a/apidoc/colors.rst +++ /dev/null @@ -1,12 +0,0 @@ -Colors -====== - -.. currentmodule:: plotly.colors - -.. autosummary:: - - make_colorscale - -.. automodule:: plotly.colors - :members: - diff --git a/apidoc/conf.py b/apidoc/conf.py index 50e121f8f..0e386a14a 100644 --- a/apidoc/conf.py +++ b/apidoc/conf.py @@ -46,12 +46,14 @@ "sphinx.ext.todo", "sphinx.ext.coverage", "sphinx.ext.napoleon", + ] autosummary_generate = True # Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +templates_path = ['_templates'] + # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: @@ -90,7 +92,9 @@ # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + 'analytics_id':'UA-39373211-1' + } # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/apidoc/figure.rst b/apidoc/figure.rst new file mode 100644 index 000000000..56ecd9bc2 --- /dev/null +++ b/apidoc/figure.rst @@ -0,0 +1,17 @@ +Figure +====== + +.. currentmodule:: plotly.graph_objects + +.. autosummary:: + :toctree: generated/ + + Figure + + Figure.show + Figure.update_layout + Figure.add_traces + + +.. autoclass:: Figure + :members: diff --git a/apidoc/graph_objects.rst b/apidoc/graph_objects.rst index eabec64f4..d90f17902 100644 --- a/apidoc/graph_objects.rst +++ b/apidoc/graph_objects.rst @@ -9,118 +9,111 @@ Graph objects: figures, traces and layout >>> import plotly.graph_objects as go +.. toctree:: + :maxdepth: 1 + :caption: Figure: -Classes + figure.rst + + +Layout +------ .. autosummary:: :toctree: generated/ - :template: class_figure.rst - - Figure + :template: trace.rst + + Layout + + + +Simple charts +-------------- .. autosummary:: :toctree: generated/ - :template: class.rst + :template: trace.rst - Area + Scatter + Scattergl Bar - Barpolar + Pie + Heatmap + Contour + Table + +Distributions +------------- + +.. autosummary:: + :toctree: generated/ + :template: trace.rst + Box + Violin + Histogram + Histogram2d + Histogram2dcontour + +Finance +------- + +.. autosummary:: + :toctree: generated/ + :template: trace.rst + + Ohlc Candlestick - Carpet - Choropleth - Choroplethmapbox - Cone - Contour - Contourcarpet - Densitymapbox - FigureWidget - Frame + Waterfall Funnel Funnelarea - Heatmap - Heatmapgl - Histogram - Histogram2d - Histogram2dContour Indicator - Isosurface - Layout - Mesh3d - Ohlc - Parcats - Parcoords - Pie - Pointcloud - Sankey - Scatter + +3D +-- + +.. autosummary:: + :toctree: generated/ + :template: trace.rst + Scatter3d - Scattercarpet - Scattergeo - Scattergl - Scattermapbox - Scatterpolar - Scatterpolargl - Scatterternary - Splom - Streamtube - Sunburst Surface - Table - Violin + Mesh3d + Cone + Streamtube Volume - Waterfall + Isosurface + +Maps +---- +.. autosummary:: + :toctree: generated/ + :template: trace.rst -Submodules + Scattergeo + Choropleth + Scattermapbox + Choroplethmapbox + Densitymapbox +Specialized +----------- .. autosummary:: + :toctree: generated/ + :template: trace.rst - area - bar - barpolar - box - candlestick - carpet - choropleth - choroplethmapbox - cone - contour - contourcarpet - densitymapbox - funnel - funnelarea - heatmap - heatmapgl - histogram - histogram2d - histogram2dcontour - indicator - isosurface - layout - mesh3d - ohlc - parcats - parcoords - pie - pointcloud - sankey - scatter - scatter3d - scattercarpet - scattergeo - scattergl - scattermapbox - scatterpolar - scatterpolargl - scatterternary - splom - streamtube - sunburst - surface - table - violin - volume - waterfall - + Scatterpolar + Scatterpolargl + Barpolar + Scatterternary + Sunburst + Treemap + Sankey + Splom + Parcats + Parcoords + Carpet + Scattercarpet + Contourcarpet diff --git a/apidoc/graph_objects_submodules.rst b/apidoc/graph_objects_submodules.rst deleted file mode 100644 index 49ddc1bb0..000000000 --- a/apidoc/graph_objects_submodules.rst +++ /dev/null @@ -1,195 +0,0 @@ -Graph objects submodules -======================== - -.. currentmodule:: plotly.graph_objects - - - -.. autosummary:: - - area - bar - barpolar - box - candlestick - carpet - choropleth - choroplethmapbox - cone - contour - contourcarpet - densitymapbox - funnel - funnelarea - heatmap - heatmapgl - histogram - histogram2d - histogram2dcontour - indicator - isosurface - layout - mesh3d - ohlc - parcats - parcoords - pie - pointcloud - sankey - scatter - scatter3d - scattercarpet - scattergeo - scattergl - scattermapbox - scatterpolar - scatterpolargl - scatterternary - splom - streamtube - sunburst - surface - table - violin - volume - waterfall - - -.. automodule:: plotly.graph_objects.area - :members: - -.. automodule:: plotly.graph_objects.bar - :members: - -.. automodule:: plotly.graph_objects.barpolar - :members: - -.. automodule:: plotly.graph_objects.box - :members: - -.. automodule:: plotly.graph_objects.candlestick - :members: - -.. automodule:: plotly.graph_objects.carpet - :members: - -.. automodule:: plotly.graph_objects.choropleth - :members: - -.. automodule:: plotly.graph_objects.choroplethmapbox - :members: - -.. automodule:: plotly.graph_objects.cone - :members: - -.. automodule:: plotly.graph_objects.contour - :members: - -.. automodule:: plotly.graph_objects.contourcarpet - :members: - -.. automodule:: plotly.graph_objects.densitymapbox - :members: - -.. automodule:: plotly.graph_objects.funnel - :members: - -.. automodule:: plotly.graph_objects.funnelarea - :members: - -.. automodule:: plotly.graph_objects.heatmap - :members: - -.. automodule:: plotly.graph_objects.heatmapgl - :members: - -.. automodule:: plotly.graph_objects.histogram - :members: - -.. automodule:: plotly.graph_objects.histogram2d - :members: - -.. automodule:: plotly.graph_objects.histogram2dcontour - :members: - -.. automodule:: plotly.graph_objects.indicator - :members: - -.. automodule:: plotly.graph_objects.isosurface - :members: - -.. automodule:: plotly.graph_objects.layout - :members: - -.. automodule:: plotly.graph_objects.mesh3d - :members: - -.. automodule:: plotly.graph_objects.ohlc - :members: - -.. automodule:: plotly.graph_objects.parcats - :members: - -.. automodule:: plotly.graph_objects.parcoords - :members: - -.. automodule:: plotly.graph_objects.pie - :members: - -.. automodule:: plotly.graph_objects.pointcloud - :members: - -.. automodule:: plotly.graph_objects.sankey - :members: - -.. automodule:: plotly.graph_objects.scatter - :members: - -.. automodule:: plotly.graph_objects.scatter3d - :members: - -.. automodule:: plotly.graph_objects.scattercarpet - :members: - -.. automodule:: plotly.graph_objects.scattergeo - :members: - -.. automodule:: plotly.graph_objects.scattergl - :members: - -.. automodule:: plotly.graph_objects.scattermapbox - :members: - -.. automodule:: plotly.graph_objects.scatterpolar - :members: - -.. automodule:: plotly.graph_objects.scatterpolargl - :members: - -.. automodule:: plotly.graph_objects.scatterternary - :members: - -.. automodule:: plotly.graph_objects.splom - :members: - -.. automodule:: plotly.graph_objects.streamtube - :members: - -.. automodule:: plotly.graph_objects.sunburst - :members: - -.. automodule:: plotly.graph_objects.surface - :members: - -.. automodule:: plotly.graph_objects.table - :members: - -.. automodule:: plotly.graph_objects.violin - :members: - -.. automodule:: plotly.graph_objects.volume - :members: - -.. automodule:: plotly.graph_objects.waterfall - :members: - diff --git a/apidoc/index.rst b/apidoc/index.rst index 55c48a637..3cf1bf9b1 100644 --- a/apidoc/index.rst +++ b/apidoc/index.rst @@ -8,8 +8,24 @@ plotly API reference This is the reference of plotly's API. Also see `plotly's documentation website `_. +Submodules +---------- + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + px.rst + graph_objects.rst + subplots.rst + figure_factory.rst + io.rst + +Full reference list +------------------- + .. toctree:: - :maxdepth: 2 + :maxdepth: 3 :caption: Contents: px.rst @@ -17,7 +33,6 @@ This is the reference of plotly's API. Also see `plotly's documentation website subplots.rst figure_factory.rst io.rst - colors.rst From 91fdb681c9076add1c56e6c98ceb0ea72da8bfcb Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 17 Oct 2019 15:18:40 -0400 Subject: [PATCH 12/14] toc --- apidoc/_static/logo.png | Bin 0 -> 8291 bytes apidoc/conf.py | 6 +++++- apidoc/figure_factory.rst | 2 ++ apidoc/graph_objects.rst | 2 ++ apidoc/index.rst | 14 +++++--------- apidoc/io.rst | 2 ++ apidoc/px.rst | 2 ++ apidoc/subplots.rst | 2 ++ 8 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 apidoc/_static/logo.png diff --git a/apidoc/_static/logo.png b/apidoc/_static/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..10db04a6376bf11744985607259a25301732e2bd GIT binary patch literal 8291 zcmcI~cT`i`ws*jS%2AFDY>?xTqEw|TU~H(=CzuMIdPC#1KLPyp?$Fz3(~Rc;k-uz3&fJ_TFpnx#pVXH|Ls@@LT#f_U<{h z2LgfY)w+4j00P+-4}tJF?Ai&Q$k*SA1V6hyZkl>RAcA6?KOQXu(Ip7vH;C4?%Xj<+ z=SN@>7SmNKON$;n{PiznBv0Egv@;&_j{UWBDpS{BI9a|&|IKx6+pf_wMTcVIy!Sgw z9x)-6)=R&@m=_5;zPTrq=6|ZHB5PM{flS1&sV$ZDuX>y#3K?UsJW~{K(Z$-oBgpD3 zHFAP~wdW=~fW}k@40)Kr&+vd>Uh)4j>;jxaej0wW;RVe8*C9A~Hw5yp;b$^jsy~t8 z-u^^}d;2dk+^hdjwB~7E*sanT*e82To9J<^-Z{6g5l=*sT0V=FF_zO1h(p+D;Kjvz z?}l&6AC|PW`#>3QR~sa2A!KPm_UIo6${5Kl%wcf`n4 z95(Kyt1UiA{RIMP``UW6l{y#du^aE&lAsF-rg(k%#on7d-RL86%YR5C0Ro}VHXm)x zvE1zkhd_Qk3(s`Y{POr>?UUZO3}7(ZTkjYCxxG?_qXophI=6pZzMn1(=FIaP1PbB~ z+jYU!Ps6WgflhxKF4b;_KzNC9(kiCDOPqTttD~(1%o!EnFW-wypVBe-I@A1p78i4q#HdQkIXS3nzunnl9H<^f6KrY`Qa{ z>FZm`d#JY(iftP4GAlHazQ{hzRGEnoB0pkmP3HtGckP~Mz+d(D7>gVt4<$PwB)I8I zYgd_xeoZNi(X0+b-gjd+Sa+}4)(a)6X%X9P49$Cpwd_0aU(cEhD9F89Xzi*?L3*bE zfgG<{7CMKz3l_hw?<+oOYx34Lgqf4_n@#>(JBzrxGnr9fW3}OW`~%{YZ0Oar~kWIi7R)ftwx@1d99q;ZP`TAuf%h(HaLAd4GczTc#q*3i}*FQ1FV6+Sqmyg3Z<}5=S5vux~&+ze_m!S(jY*Zw*I=RG;HIOjm6)#N@OAJ- zI#&4@=ZklPDaIi_K;c%^8aGj!z3T8}*x+Iy8ogh3(8DyH%P_CF%nD$5m|0+z66Bxa z>D;6s$5xdFFD-AeD5*hkmLd=k#P}*&)e4RQ=2>tIW{Rr-_L3j0HCbIX(n2D|WFXiL zHIF7|!l8GQw3K69L`{)jaRQh*v4Ld0>lHfd?<&97lIumW(QC6Rm|?v~w57(^+i9L+ zjIPQotQnP+M#gPzF}t8qJ;>W(@3+y*mJZSr+QrkW@_SQNaO7v3+fufE^9;MNblP|H zn^pOOK;v<(tms{_(dHI=^=X%lW%^Y_=#TxcF9^%t#LVS2hoA=d=LQ~ho4>e_h_mCX zy^y@V;Sn3n5Wk4t^Glpsqn|+eiz%v$eEAuhJ@G)U-C=$I@&oEQtJ!;)%XC^m8=9Ku zv|nLb*>T?{Y?aEB_`%C)LQK(IqVPL65 zQ>@c*ctCO_b&CPh8g;i>PN6D|!B=3wp3H)r_faGe(>E8xx>-y^kJ4c^%~D+qqrw=< zb1-!SYV%L;K{-uSW2Yt+0`dq&u~U-(ED$GaR^E5Ar*s)3@G7Xm;tYJk$5Ywb%hd?m zzb76djkZnh3i4#XlM;~q18P=k?e_4Dtof&cz;}wU^Ufx71(b{E3%79d3MlKr^MSv+ ze^b{KOdZK;>9y1}bOU;Qijwd{dBNbAZ8MMA|wth!}4%m7BvjUqAXJajuo zR{ge*%|);)vB6s*r;6?_ZojDm%g_9Ma|mh)1DWlW10E)y@(Kp=j^f_QK@QAteI zIB&BzGkYoTR_O^*rg`H`1@l{#u^!5yVti1VrD`P?v;y4Lt0~M(;Lu@NUre9_>Iy!p zBrR(Nkcdg7!FZ--Li8*JgNB#MjqZ}GTWQT%6UjyWdt7kCZ^_Y~Xh zA6xe*vqN2BwE{G-oqw@tF610Ab^)+a`@6_QCtJGj@c~7Hm`<~}?!$jFba3h*TM%5{ zg{90$4jG0tI2m-BwqDjNAV}HpUSbI?FC;l$w6HoX+eVHXG~!HOYrz~divhgeif8aw z9Kt(KJW^<4N!p@_9q(P_51fS>^kn4ggpv49H>GCvG2b*GZFcBFR5Nqz8Igaq=xAku zSM&WmPT#ha@irSN%E;;!_3pE%-5#vqak;}$T-B(gk?oQMfZqXrR0KIUig#Qfo&VbB zy_|eCRj(?U_f|TuPHwSLD}88j zbXhW+d1<2uw@-R}6*HWR5}7uj6F$ElUuJE3sLy{mH8GT7_S@ztTM-6DC?BPtkg1=; zk8FAb-s&nWOkP!A%Fcfn*j+MdQR|Y%iS#q>8>-#vUvp?pWhRvK4DFST4gYF(26nO9 zp%F<>k`qS<&Nik|F3TmuQM70E4 z?qx|4+u*dA_5m%8Di;;tA@x~uLOqGsYUf_!s?L!;3)-XUYVc&ZEc;PP0ZgZQy?Ed` zEldS7;oQhd#Ppjb#u$1C*gs>l^CrWR_%s;QFRkW=n`^zx zb!|_c7RV6OHu0utvqdY6FCH16g(&$v@IVp3{;bxhp2kM6h~3bFOm!SZLi)30iS%a< z?-3l{LFNF}Z?BRklSkjcrq~ma_0w_L^dxI(V&*2^2++HZp#xkkc7KU?Ey%9UK77#u zuO|?9+UN;Ft_}Xx_=r=vU3jl3uRSxxf5HpVF0wj|r>WDf1f85|6N39v=4|Ww1c&Zy z^}K=Q`2t&X?S2Sr1&FVf6rqfHTg)Y?YVA=h6(? z>@18;XEGD1V=fzxC1c8;NR9lSoG!o|+XNjszW}%dZ$%%IFk}?>~F~?N(L6PO89-N9h56SEY>Z z<0lP1_R&wMm%lYGNWxJh@R?6!bapCj$RxW0ar1V3{%_vrL;HMjib0vAZ7Xs$PEum zE^^HkT$0I;1$*wa()?RV8SeX6=U2D;n50*Y^_BuY+V%>sjpZ4-UJ4Uz>bX=CGKNbI!b$RLY%a z^&C!V|JyQsgBY4})@UD}$5SBhUf423t9FK2?G}Lh-&La6Sz}7v0u-%IarPZ?z6K|6 z9`}pWF`70fT3Z$>Y|;H_U}+ zR@LX1iVf&|{C=(Q`(X`w1l0;Z+ol4~{-UXj2|b`aPwyaP1=ihNA{>&w34zQjB}FW( zhE0xicdbuSwRk}wqI-l(Lm;;d-du2OIgqCXj(2gN3@;Q$M+&#=@^I7|={n7geHl{% zHAb7`%CJabv;5c}M#cjP{!mUl@=esjuuCj z;PnGWjFWxzLp_a8Z*Uibqy~D2=1KhX6YbvDabiyr8_v?VJ95dTT>oJU;MgbpIfOH3 zg`76$1Y^i0;bV@b90vlG0WY#*TQS!=z`Erb;c;SIrXiPndk%lt_fHa*-IrQ0Ak=66 z_)0OA7$?R7Le58cN}QN?$B&z1#gpzFej)826zRp%rpjDqMOJODI^A!)sO)o>m}nj+ z-9@ZAW5c_2AInwqWmPr7zxTA)$<4Ir7qb}k_g&f@Ry9^SDEgxn%Cjb&8T6VvZVbM; zPM(q@#lWC%V%N7_I?oB%$bRENeZl!_+QMqQ_NJqO=a`e`uzgAb02EdL6r(QI;MfZ> zn&X!@CXVz*a?C2t4I~UC*a>JxH7XXN>5Mt$5$@6g;Cl*Q6BtB_~w#Z2id& zc0#G`KMZ`xC&IM$LDS}%v3%hCR1GZ9wQw)6XotFfp!BMfB7b~TwELkB=@#hdT?;pV zvl?cof+JNxs<764wckBaB(m=ldv29&;kzr3$ZH zT20b`0q75Tsj5)d^9q_?q>uGguwJcx|PI z7G6s84qY1IG1K(E+EdrC{f_Q`dy@VqjkCP=NzQgCWd+!*-&%7VA)ezd#Hv#^ydLsc zR^3BqXzA_9yePs|(y+50q#7c}Hh(Nz$}RzR=krYXusCQiE1LI-(oIsGoo7 zQ6STT<7?o6y$pBli+Ava7Wv<%-HiC1qM%pY5^%}MIB(SBj%Gr4_d2RG?r$%8l_up{ zYLR!WF7}x9Bd0#0+iEmI1#6Wqio8N;9y+%ZaJayH*Q6OpAB6h&os_Xj#A&vY-)de> zM!ft(H_MU8O%KE&Iu;-MHf7xCiQaOf1<3fioGYJ3MElyv?d|09*}x<6BQa&=ixPUH z?p3aGz`>=-v6~(iEdzgmEUyrDVli{HWuMIH=KM6KX|y91mhN>#o^PMbqJ&Z>$7xe{ zVq@kQVUu_ri%M&~BHX%2{7UMq2*o47XfFtOBT2ZuDYwg?*C$Y`fNdfwE;(A49E)O)nL@(ZX;0Fr?kO>xYDJmx@1P!hF-1c*mU z%MOir6LY#2B`ScGr#4L9;_CS66AH`pmC}WqMc65OI_)&}EiO_}dJtOdY9gDN1*}41 zW~N6n(AvT81Qw4I0GiKp+FF2>qBV9DEBL&&6PfYZ}+Og zPBAD55@iM?T;>{@42I0H-q{|q!1u7px~+h<9d!#X@+(VmE8TQa+dQrI=SXmN)8t!r zrOVG}jE;s=5J4wB)td4`oczJNx#c%}>%L1~rF(rXuRbzp{18C2{{8XMyv(Q1E3|e> zejZ@@mvofpi!n>XH*<;uQaDb|TbpCydFGDHNl&>ZrP!~d?A!*1)qADtP9V%Iv)R2) z0m59^R4p{;l)mJ<1+V32<+hw@Bd0G8&3|Cb$0;Pt8D) zUQk5>+^!9;#A{wozx+U@sY3E|71MMinmH8WT+<7UQqg;FoHHx`@CRQnW(iH7NZoCG zFOo(3j9w#Yp2|n{3|F@$Z*Ps`#*5$sf{WYi9Q1xYx+`Ji6|Sc)TziCcJnNn_CyC(= zu2;K~#Wek1ZK)ufWRhH!D`mq;aCw70&iomV3!O9HfS(V?Ysq$hH*-q@XV&pg`Ma?p ze=-NYR#zn!LD^T^fYk(0)sQ*dpmk$)$lzEH0dx6*9R)!j$C1+cByT8060qPZJ!NqXJ*dU9i#d*oHBo+3u;0;Qvxt3)@znZWdG z7sQu;WVI;d6Q}f&kb!dp>H0cbeRiWFxn7JwGM)n~Zh4hfzO2tI^cIQXMrG;G^bd{I z;1v6prSzTq)(x4ie8O*9%9#UA&&wFK1Fgis@LMg*U;MUimkxjW(mES@%-WdiBVuxX zJ57gKKIy5pV>eg83F?^FgS4}!A0&B`+bVk4fkW)MDJ0qFS@pFes-w;V*e9aUz7w(s z1sEWfzp+d61&VV$^zJ##qSW2%8_(XJu}5)v7xKOHE&|LQL+-1&w$>-;)qWtP7a%n%Md$P-7}80iaXNRP%21#-Jp9E0;2px_%B;K|-s% z4XQ|(wzxj9wp=9Hh&(Kvw06S3Ba+H53ChiewdYV^aFMjRs2D{TJ>GNA{r+zLYNV<9 zoUKaJsHAnn9huy0t=_0LDNv}!2d=iV=h&N7-)pNiTnj!L3(Hw*jN*fQ)^@x%f#u{zHANly_4|%nmm}5w)!Z3(xqx0Cj?a;RW{hFLy91E)qrd6iRX=4=8p#z z+il_yDWSPOLTR`6sWz*H0E;cE&g*rJJdm%|o(h?+mlkb+42offjA3IMuFz_@81@r&LULk_g^%!NDc8yP~H?Gtba$3yBDoO9U$$ZwT z=T3qxdIP~Nnr90lL*0%;aOV-zRv1#K4o}Rf^_F>gPT?CaNlh0uB)RU2=cOFjn23C^ zHrRynU13bYE-IlW<$T$^l!LG(UyQ~1i2`J$8l-V=LdAKOk0}YG8#8AtAb6$r&{^z! zn~)G9J!)`liN<UJThHqeLVop3i|Dx`ry>9g zTiu8LL!0AX9o%|W<*r`@!a{*GdEZ;Rkr<9R&_dv)7{I=(#JGqL_+9H)XP+JO9@q~- z98%=#nQ5PH+}^aohg!wV@xSEF3f|2*(Y*RI`x7vWpL&)*wJZPap5;$u{=3%a|1B-k zh;0@7mqs}oND0;W*QMo;%Z^IW@RZw(_S<|iCt*rZd))j!*|#YF7to-jHeW^U^bs4^ z;IwAcOF(NA`UafLv|%~l-&Zj#AsI=eDQbV*{j)5 z8#EPv67&DIEBq6ge_O&F{r_KS{(q!3X~8-PmfFqvUjWD@78|B1cj}GtUn1|pLx`59 L{` +* :ref:`Graph objects: figures, traces and layout ` +* :ref:`Subplots ` +* :ref:`Figure Factory ` +* :ref:`I/O ` Full reference list ------------------- .. toctree:: :maxdepth: 3 - :caption: Contents: px.rst graph_objects.rst diff --git a/apidoc/io.rst b/apidoc/io.rst index 4745000c6..c241ff703 100644 --- a/apidoc/io.rst +++ b/apidoc/io.rst @@ -1,3 +1,5 @@ +.. _io: + I/O ============== diff --git a/apidoc/px.rst b/apidoc/px.rst index 87cb5a2a8..7873c72fc 100644 --- a/apidoc/px.rst +++ b/apidoc/px.rst @@ -1,3 +1,5 @@ +.. _px: + Plotly express: `plotly.express` ================================ diff --git a/apidoc/subplots.rst b/apidoc/subplots.rst index a29ed0c67..dbacf971b 100644 --- a/apidoc/subplots.rst +++ b/apidoc/subplots.rst @@ -1,3 +1,5 @@ +.. _subplots: + Subplots: `plotly.subplots` =========================== From 6c2801e231da0dc71f0f8cc9f04728fc5cfe8783 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 17 Oct 2019 15:49:10 -0400 Subject: [PATCH 13/14] CI --- .circleci/config.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.circleci/config.yml b/.circleci/config.yml index 51640a785..d0ebb1e2a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -77,6 +77,18 @@ jobs: pip install -e . cd ../../../../apidoc make html + if [ "${CIRCLE_BRANCH}" == "master" ]; then + cd _build/html + git init + git config user.name nicolaskruchten + git config user.email nicolas@plot.ly + git add * + git commit -m build + git push --force git@github.com:plotly/plotly.py-docs.git master:gh-pages + rm -rf .git + cd ../.. + fi + cd .. rm -rf plotly-master From e7f7920bb71ade366e7b9d3e845a628fde722e06 Mon Sep 17 00:00:00 2001 From: Emmanuelle Gouillart Date: Thu, 17 Oct 2019 15:58:06 -0400 Subject: [PATCH 14/14] CI --- .circleci/config.yml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index d0ebb1e2a..8e17569e0 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -72,10 +72,7 @@ jobs: name: make doc command: | . venv/bin/activate - git clone https://github.com/plotly/plotly.py.git plotly-master - cd plotly-master/packages/python/plotly - pip install -e . - cd ../../../../apidoc + cd apidoc make html if [ "${CIRCLE_BRANCH}" == "master" ]; then cd _build/html @@ -90,7 +87,6 @@ jobs: fi cd .. - rm -rf plotly-master - store_artifacts: