[WIP] document API using sphinx

doc/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)

doc/README.rst

@@ -0,0 +1 @@
+make html

doc/conf.py

@@ -0,0 +1,194 @@
+# -*- 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"
+
+# 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

doc/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:
+

doc/graph_objects.rst

@@ -0,0 +1,6 @@
+GO
+===
+
+.. automodule:: plotly.graph_objects
+   :members:
+

doc/index.rst

@@ -0,0 +1,25 @@
+.. 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
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/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:
+

doc/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:
+

packages/python/plotly/plotly/figure_factory/__init__.py

@@ -30,3 +30,22 @@
 
 if optional_imports.get_module("pandas") is not None:
     from plotly.figure_factory._county_choropleth import create_choropleth
+
+__all__ = [
+    "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",
+]

packages/python/plotly/plotly/graph_objects.py

@@ -1,2 +1,19 @@
 from __future__ import absolute_import
 from plotly.graph_objs import *
+
+__all__ = [
+    "Scatter",
+    "ScatterGL",
+    "Bar",
+    "Heatmap",
+    "Contour",
+    "Table",
+    "Figure",
+    "Layout",
+    "Pie",
+    "Box",
+    "Violin",
+    "Histogram",
+    "Volume",
+    "Isosurface",
+]

packages/python/plotly/plotly/graph_objs/__init__.py

@@ -92739,3 +92739,4 @@ def __init__(
     Trace,
     Histogram2dcontour,
 )
+