diff --git a/bqplot/__init__.py b/bqplot/__init__.py index 3b64b5e90..406cfc6ef 100644 --- a/bqplot/__init__.py +++ b/bqplot/__init__.py @@ -24,10 +24,11 @@ Each plot starts with a `Figure` object. A `Figure` has a number of `Axis` objects (representing scales) and a number of `Mark` objects. `Mark` objects are a visual representation of the data. Scales transform data -into visual properties (typically a number of pixels, a color, etc.). :: +into visual properties (typically a number of pixels, a color, etc.). + +.. jupyter-execute:: from bqplot import * - from IPython.display import display x_data = range(10) y_data = [i ** 2 for i in x_data] @@ -35,21 +36,20 @@ x_sc = LinearScale() y_sc = LinearScale() - ax_x = Axis(label='Test X', scale=x_sc, tick_format='0.0f') - ax_y = Axis(label='Test Y', scale=y_sc, - orientation='vertical', tick_format='0.2f') - - line = Lines(x=x_data, - y=y_data, - scales={'x': x_sc, 'y': y_sc}, - colors=['red', 'yellow']) + ax_x = Axis(label="Test X", scale=x_sc, tick_format="0.0f") + ax_y = Axis( + label="Test Y", scale=y_sc, orientation="vertical", tick_format="0.2f" + ) - fig = Figure(axes=[ax_x, ax_y], marks=[line]) + line = Lines( + x=x_data, y=y_data, + scales={"x": x_sc, "y": y_sc}, colors=["red", "yellow"] + ) - display(fig) + Figure(axes=[ax_x, ax_y], marks=[line]) .. automodule:: bqplot.figure -.. automodule:: bqplot.scales +.. automodule:: bqscales.scales .. automodule:: bqplot.marks .. automodule:: bqplot.axes .. automodule:: bqplot.market_map diff --git a/docs/environment.yml b/docs/environment.yml index ac89744e6..fe1b95d4d 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -2,11 +2,8 @@ name: bqplot_docs channels: - conda-forge dependencies: - - python=3.5 - - traitlets - - traittypes - - widgetsnbextension - numpy - pandas - bqplot - - nbsphinx + - sphinx_rtd_theme + - jupyter_sphinx diff --git a/docs/source/conf.py b/docs/source/conf.py index 45d05e67e..982c56e59 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,6 +19,8 @@ import sys import os +import sphinx_rtd_theme + # 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. @@ -42,7 +44,7 @@ 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', - 'nbsphinx', + 'jupyter_sphinx', ] autosummary_generate = True @@ -83,142 +85,23 @@ # The full version, including alpha/beta/rc tags. release = _release['__version__'] -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. language = None -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- 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 themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# 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'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] htmlhelp_basename = 'bqplotdoc' # -- 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_elements = {} # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, @@ -228,27 +111,6 @@ u'Bloomberg LP', 'manual'), ] -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples @@ -258,10 +120,6 @@ [u'Bloomberg LP'], 1) ] -# If true, show URL addresses after external links. -#man_show_urls = False - - # -- Options for Texinfo output ------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples @@ -272,15 +130,3 @@ u'Bloomberg LP', 'bqplot', 'One line description of project.', 'Miscellaneous'), ] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False diff --git a/docs/source/usage.ipynb b/docs/source/usage.ipynb deleted file mode 100644 index 0d4439286..000000000 --- a/docs/source/usage.ipynb +++ /dev/null @@ -1,94 +0,0 @@ -{ - "cells": [ - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "# Usage\n", - "\n", - "## Examples\n", - "\n", - "Using the pyplot API" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "import numpy as np\n", - "from bqplot import pyplot as plt\n", - "\n", - "plt.figure(1, title='Line Chart')\n", - "np.random.seed(0)\n", - "n = 200\n", - "x = np.linspace(0.0, 10.0, n)\n", - "y = np.cumsum(np.random.randn(n))\n", - "plt.plot(x, y)\n", - "plt.show()" - ] - }, - { - "cell_type": "markdown", - "metadata": {}, - "source": [ - "Using the bqplot internal object model" - ] - }, - { - "cell_type": "code", - "execution_count": null, - "metadata": {}, - "outputs": [], - "source": [ - "import numpy as np\n", - "from IPython.display import display\n", - "from bqplot import (\n", - "OrdinalScale, LinearScale, Bars, Lines, Axis, Figure\n", - ")\n", - "\n", - "size = 20\n", - "np.random.seed(0)\n", - "\n", - "x_data = np.arange(size)\n", - "\n", - "x_ord = OrdinalScale()\n", - "y_sc = LinearScale()\n", - "\n", - "bar = Bars(x=x_data, y=np.random.randn(2, size), scales={'x': x_ord, 'y':\n", - "y_sc}, type='stacked')\n", - "line = Lines(x=x_data, y=np.random.randn(size), scales={'x': x_ord, 'y': y_sc},\n", - " stroke_width=3, colors=['red'], display_legend=True, labels=['Line chart'])\n", - "\n", - "ax_x = Axis(scale=x_ord, grid_lines='solid', label='X')\n", - "ax_y = Axis(scale=y_sc, orientation='vertical', tick_format='0.2f',\n", - " grid_lines='solid', label='Y')\n", - "\n", - "Figure(marks=[bar, line], axes=[ax_x, ax_y], title='API Example',\n", - " legend_location='bottom-right')" - ] - } - ], - "metadata": { - "kernelspec": { - "display_name": "Python 3", - "language": "python", - "name": "python3" - }, - "language_info": { - "codemirror_mode": { - "name": "ipython", - "version": 3 - }, - "file_extension": ".py", - "mimetype": "text/x-python", - "name": "python", - "nbconvert_exporter": "python", - "pygments_lexer": "ipython3", - "version": "3.7.6" - } - }, - "nbformat": 4, - "nbformat_minor": 2 -} diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 000000000..98a8fbb10 --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,65 @@ +Usage +===== + +Examples +-------- + +Using the pyplot API: + +.. jupyter-execute:: + + import numpy as np + from bqplot import pyplot as plt + + plt.figure(1, title="Line Chart") + np.random.seed(0) + n = 200 + x = np.linspace(0.0, 10.0, n) + y = np.cumsum(np.random.randn(n)) + plt.plot(x, y) + plt.show() + +Using the bqplot internal object model: + +.. jupyter-execute:: + + import numpy as np + from IPython.display import display + from bqplot import OrdinalScale, LinearScale, Bars, Lines, Axis, Figure + + size = 20 + np.random.seed(0) + + x_data = np.arange(size) + + x_ord = OrdinalScale() + y_sc = LinearScale() + + bar = Bars( + x=x_data, y=np.random.randn(2, size), scales={"x": x_ord, "y": y_sc}, type="stacked" + ) + line = Lines( + x=x_data, + y=np.random.randn(size), + scales={"x": x_ord, "y": y_sc}, + stroke_width=3, + colors=["red"], + display_legend=True, + labels=["Line chart"], + ) + + ax_x = Axis(scale=x_ord, grid_lines="solid", label="X") + ax_y = Axis( + scale=y_sc, + orientation="vertical", + tick_format="0.2f", + grid_lines="solid", + label="Y", + ) + + Figure( + marks=[bar, line], + axes=[ax_x, ax_y], + title="API Example", + legend_location="bottom-right", + )