Skip to content

Doc organize axes docs #7176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Sep 29, 2016
Merged

Doc organize axes docs #7176

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
0de8fed
DOC: start to overhaul Axes API docs
tacaswell Sep 25, 2016
474f1ee
DOC: patch up documentation on Axes
tacaswell Sep 25, 2016
ab31bf2
DOC: use explicit autosummary tables for Axes
tacaswell Sep 25, 2016
ef583fc
DOC: organize plotting methods
tacaswell Sep 25, 2016
f893dc3
DOC: straighten rst adornment + reorg a section
tacaswell Sep 25, 2016
322c75f
DOC: patch up docstring on Artist.pick
tacaswell Sep 25, 2016
ba2bd6a
STY: PEP8 removal of whitespace
tacaswell Sep 25, 2016
64dc7af
MNT: add auto-generated rst files to gitignore
tacaswell Sep 25, 2016
7b29662
MNT: move around methods on Axis and friends
tacaswell Sep 25, 2016
9925fc2
DOC: re-arranging the Axis and Tick API docs
tacaswell Sep 25, 2016
650b640
DOC: numpydocify Axes.tick_params
tacaswell Sep 26, 2016
cbb8e7d
DOC: more section reorganization in axis docs
tacaswell Sep 26, 2016
f5d8848
DOC: change inheritance diagram to get all Artists
tacaswell Sep 26, 2016
58b4dbd
DOC: use auto-summary in artist api docs
tacaswell Sep 26, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
DOC: organize plotting methods
  • Loading branch information
@tacaswell
tacaswell committed Sep 25, 2016
commit ef583fc4591995a999e615e93513624394e15d35
176 changes: 132 additions & 44 deletions doc/api/axes_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,71 +14,159 @@
Plotting
--------

Basic
~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.plot
Axes.errorbar
Axes.scatter

Axes.plot_date
Axes.step

Axes.loglog
Axes.semilogx
Axes.semilogy

Axes.fill_between
Axes.fill_betweenx

Axes.bar
Axes.barh

Axes.stem
Axes.eventplot

Axes.pie

Axes.stackplot


Axes.broken_barh
Axes.vlines
Axes.hlines
Axes.fill

Spans
~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.acorr
Axes.angle_spectrum
Axes.annotate
Axes.arrow
Axes.axhline
Axes.axhspan
Axes.axvline
Axes.axvspan
Axes.bar
Axes.barbs
Axes.barh
Axes.boxplot
Axes.broken_barh
Axes.bxp
Axes.clabel

Spectral
~~~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.acorr
Axes.angle_spectrum
Axes.cohere
Axes.contour
Axes.contourf
Axes.csd
Axes.errorbar
Axes.eventplot
Axes.fill
Axes.fill_between
Axes.fill_betweenx
Axes.magnitude_spectrum
Axes.phase_spectrum
Axes.psd
Axes.specgram
Axes.xcorr

Statistics
~~~~~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.boxplot
Axes.violinplot

Axes.violin
Axes.bxp

Binned
~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.hexbin
Axes.hist
Axes.hist2d
Axes.hlines

Contours
~~~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.clabel
Axes.contour
Axes.contourf

Array
~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.imshow
Axes.loglog
Axes.magnitude_spectrum
Axes.matshow
Axes.pcolor
Axes.pcolorfast
Axes.pcolormesh
Axes.phase_spectrum
Axes.pie
Axes.plot
Axes.plot_date
Axes.psd
Axes.quiver
Axes.quiverkey
Axes.scatter
Axes.semilogx
Axes.semilogy
Axes.specgram
Axes.spy
Axes.stackplot
Axes.stem
Axes.step
Axes.streamplot
Axes.table
Axes.text
Axes.tricontour
Axes.tricontourf

Unstructured Triangles
~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.tripcolor
Axes.triplot
Axes.violin
Axes.violinplot
Axes.vlines
Axes.xcorr
Axes.tricontour
Axes.tricontourf


Text and Annotations
~~~~~~~~~~~~~~~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.annotate
Axes.text
Axes.table
Axes.arrow


Fields
~~~~~~

.. autosummary::
:toctree: _as_gen
:nosignatures:

Axes.barbs
Axes.quiver
Axes.quiverkey
Axes.streamplot


Clearing
--------
Expand Down