Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
73 commits
Select commit Hold shift + click to select a range
f4f9827
Update configuration; use Enthought sphinx template if available.
corranwebster May 20, 2019
df6b032
[WIP] new content, some re-organizaition of existing content
corranwebster May 20, 2019
791410c
Update license dates.
corranwebster May 20, 2019
0090911
[WIP] Start developer reference proper.
corranwebster Jun 13, 2019
6a7240c
More WIP
corranwebster Jul 13, 2019
83fc339
Add index for api docs.
corranwebster Jul 13, 2019
ef505c6
FIX: Add missing imports to api
Jul 13, 2019
50a5104
DOC: Fix missing link warnings
Jul 13, 2019
278d537
DOX: Fix line header length warnings
Jul 13, 2019
c965de7
DOC: Fix missing link to installation instructions
Jul 13, 2019
a716ad3
DOC: Remove link to Enthought wiki
Jul 13, 2019
6b42843
DOC: Fix broken link to mappers
Jul 13, 2019
3788ae8
DOC: Fix broken formatting in renderer index
Jul 13, 2019
f2d452b
DOC: Remove empty tutorial_wx file
Jul 13, 2019
adfe984
DOC: Mark already-referenced as :orphan:
Jul 13, 2019
0407530
DOC: Fix RST link in ToolbarPlot
Jul 13, 2019
3f7fe24
DOC: CLN: Remove links to old webinars
Jul 13, 2019
d640235
DOC: CLN: Remove resource.rst and move contents
Jul 13, 2019
93da8fa
CLN: Remove and update links to code.enthought.com
Jul 13, 2019
59eb915
DOC: CLN: Fix warnings to unescaped * and broken link
Jul 13, 2019
d2f251e
DOC: Link tutorials from User Guide
Jul 13, 2019
552b0fd
DOC: Fix layout of modules_and_classes
Jul 13, 2019
90140dd
DOC: Move programmers_reference documents into user guide
Jul 13, 2019
c8cdd0d
DOC: Clean up quickstart for formatting and links
Jul 13, 2019
763d635
DOC: Use proper TOC for How do I
Jul 13, 2019
7afaef8
DOC: Fix indentation in quickstart
Jul 13, 2019
0a41fee
DOC: Move architecture_overview to dev reference
Jul 13, 2019
2d460d5
DOC: Fix RST in data_sources
Jul 13, 2019
20ce8c5
FIX: Fix circular import in transform_color_mapper
Jul 13, 2019
0fb7d04
DOC:CLN: Remove mention of PolarMapper
Jul 13, 2019
3280b0b
DOC: Fix RST links for data sources
Jul 13, 2019
ce22da3
DOC: Fix RST links for mappers
Jul 13, 2019
672de1f
DOC: Fix RST links for data ranges
Jul 13, 2019
32e715a
DOC: Fix RST links for plot types and renderers
Jul 14, 2019
a963fd3
FIX: Circular import in toolbar_plot
Jul 14, 2019
2a99933
DOC: Fix API doc links for plot_factories
Jul 14, 2019
d0d94b2
FIX: Circular imports in tools
Jul 14, 2019
17f5203
DOC: Fix API doc links for tools
Jul 14, 2019
4edd709
DOC: Fix API doc links for axis.rst
Jul 14, 2019
ebb84df
DOC: Fix API doc links for visual components
Jul 14, 2019
66ee914
DOC: Fix API doc links for containers
Jul 14, 2019
0d116af
DOC: Add support for intersphinx for enable
Jul 14, 2019
b57a51b
DOC: Add missing MinorPlotAxis to API docs
Jul 14, 2019
de248cc
DOC: Fix RST formatting
Jul 14, 2019
a90efc2
DOC: Add curstor tools to API docs
Jul 14, 2019
bb3ae53
DOC: Add SelectableLegend to API docs
Jul 14, 2019
b29cffb
DOC: Fix API links in user guide
Jul 14, 2019
1daadab
DOC: Fix formatting in quickstart
Jul 14, 2019
4d60501
Add Quickstart to userguide
Jul 14, 2019
f3f53ee
DOC: Use unique RST name for API docs
Jul 14, 2019
967bb84
DOC: Link to PDF version of 2008 tutorial slides
Jul 14, 2019
19bfddd
Remove duplicate entry in user_guide/index
Jul 24, 2019
502023e
FIX: Enable disabling sidebar with new theme
Jul 24, 2019
be8fad2
Merge branch 'master' into docs/documentation-update
timdiller May 25, 2020
e8df83f
Merge branch 'master' into docs/documentation-update
aaronayres35 Mar 9, 2021
02f92b7
Merge branch 'master' into docs/documentation-update
aaronayres35 Mar 10, 2021
b6a92b2
Merge branch 'master' into docs/documentation-update
aaronayres35 Mar 10, 2021
c5d11d0
fix broken links and typos in fundamentals.rst
aaronayres35 Mar 10, 2021
0f8a0cb
bunch more typo and broken link fixes
aaronayres35 Mar 10, 2021
36ed7f6
more typos and links
aaronayres35 Mar 11, 2021
7e0c423
more clean up, remove repeated sections
aaronayres35 Mar 11, 2021
31971b2
remove empty sections of user guide introduction (they are covered la…
aaronayres35 Mar 11, 2021
22567d6
re-order usermanual a bit
aaronayres35 Mar 11, 2021
6ff7f20
tools and overlays are on separate pages
aaronayres35 Mar 11, 2021
179f6a5
tool page title fix
aaronayres35 Mar 11, 2021
c1eed42
suggest pyqt5 not pyqt
aaronayres35 Mar 11, 2021
c734832
remove duplicated paragraph
aaronayres35 Mar 11, 2021
4686415
have list of pages att end of intro match pages of user guide (althou…
aaronayres35 Mar 11, 2021
c75766b
move tools.rst into basic elements
aaronayres35 Mar 15, 2021
601c796
remove redudant tutorials_and_examples.rst from user guide. Tutorials…
aaronayres35 Mar 15, 2021
3537580
move quickstart.rst into use_manual as that is where it is now used
aaronayres35 Mar 15, 2021
4a31c5e
make Overays page title a higherr level heading
aaronayres35 Mar 15, 2021
f2d08db
Merge branch 'master' into docs/documentation-update
aaronayres35 Mar 30, 2021
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
13 changes: 12 additions & 1 deletion docs/source/api/axis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,37 @@
Axis and Grid
--------------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.axis

:class:`PlotAxis`
==========================
.. autoclass:: PlotAxis
:members:
:show-inheritance:

:class:`MinorPlotAxis`
==========================
.. autoclass:: MinorPlotAxis
:members:
:show-inheritance:
.. currentmodule:: chaco.label_axis

:class:`LabelAxis`
==========================
.. autoclass:: LabelAxis
:members:
:show-inheritance:

.. currentmodule:: chaco.grid

:class:`PlotGrid`
==========================
.. autoclass:: PlotGrid
:members:
:show-inheritance:

.. currentmodule:: chaco.ticks

:class:`AbstractTickGenerator`
===============================
.. autoclass:: AbstractTickGenerator
Expand Down
18 changes: 17 additions & 1 deletion docs/source/api/containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@
Containers
----------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.base_plot_container

:class:`BasePlotContainer`
==========================
.. autoclass:: BasePlotContainer
:members:
:show-inheritance:

.. currentmodule:: chaco.plot_containers

:class:`OverlayPlotContainer`
=============================
.. autoclass:: OverlayPlotContainer
Expand All @@ -35,3 +37,17 @@ Containers
.. autoclass:: GridPlotContainer
:members:
:show-inheritance:

:class:`StackedPlotContainer`
=============================
.. autoclass:: StackedPlotContainer
:members:
:show-inheritance:

.. currentmodule:: chaco.selectable_overlay_container

:class:`SelectableOverlayPlotContainer`
=======================================
.. autoclass:: SelectableOverlayPlotContainer
:members:
:show-inheritance:
10 changes: 8 additions & 2 deletions docs/source/api/data_ranges.rst
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@

.. _data_ranges:
.. _data_ranges_api:

Data Ranges
-----------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.abstract_data_range

:class:`AbstractDataRange`
==========================
.. autoclass:: AbstractDataRange
:members:
:show-inheritance:

.. currentmodule:: chaco.base_data_range

:class:`BaseDataRange`
======================
.. autoclass:: BaseDataRange
:members:
:show-inheritance:

.. currentmodule:: chaco.data_range_1d

:class:`DataRange1D`
====================
.. autoclass:: DataRange1D
:members:
:show-inheritance:

.. currentmodule:: chaco.data_range_2d

:class:`DataRange2D`
====================
.. autoclass:: DataRange2D
Expand Down
14 changes: 12 additions & 2 deletions docs/source/api/data_sources.rst
Original file line number Diff line number Diff line change
@@ -1,41 +1,51 @@

.. _data_sources:
.. _data_sources_api:

Data Sources
------------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.abstract_data_source

:class:`AbstractDataSource`
===========================
.. autoclass:: AbstractDataSource
:members:
:show-inheritance:

.. currentmodule:: chaco.array_data_source

:class:`ArrayDataSource`
========================
.. autoclass:: ArrayDataSource
:members:
:show-inheritance:

.. currentmodule:: chaco.multi_array_data_source

:class:`MultiArrayDataSource`
=============================
.. autoclass:: MultiArrayDataSource
:members:
:show-inheritance:

.. currentmodule:: chaco.point_data_source

:class:`PointDataSource`
========================
.. autoclass:: PointDataSource
:members:
:show-inheritance:

.. currentmodule:: chaco.grid_data_source

:class:`GridDataSource`
=======================
.. autoclass:: GridDataSource
:members:
:show-inheritance:

.. currentmodule:: chaco.image_data

:class:`ImageData`
==================
.. autoclass:: ImageData
Expand Down
24 changes: 24 additions & 0 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:orphan:

.. _api_reference:

=============
API Reference
=============

This guide provides in-depth API documentation for the main classes and
objects in the Chaco package.

.. toctree::
:maxdepth: 2

visual_components.rst
containers.rst
data_sources.rst
mappers.rst
data_ranges.rst
renderers.rst
plot_factories.rst
tools.rst
axis.rst

19 changes: 16 additions & 3 deletions docs/source/api/mappers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,66 @@
Mappers
-------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.abstract_mapper

:class:`AbstractMapper`
=======================
.. autoclass:: AbstractMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.base_1d_mapper

:class:`Base1DMapper`
=====================
.. autoclass:: Base1DMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.linear_mapper

:class:`LinearMapper`
=====================
.. autoclass:: LinearMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.log_mapper

:class:`LogMapper`
==================
.. autoclass:: LogMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.grid_mapper

:class:`GridMapper`
===================
.. autoclass:: GridMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.color_mapper

:class:`ColorMapper`
====================
.. autoclass:: ColorMapper
:members:
:show-inheritance:

.. currentmodule:: chaco.color_mapper

:class:`ColorMapTemplate`
=========================
.. autoclass:: ColorMapTemplate
:members:
:show-inheritance:

.. currentmodule:: chaco.transform_color_mapper

:class:`TransformColorMapper`
=============================
.. autoclass:: TransformColorMapper
:members:
:show-inheritance:

:show-inheritance:
10 changes: 9 additions & 1 deletion docs/source/api/plot_factories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Plot Factories
--------------

.. currentmodule:: chaco.api
.. currentmodule:: chaco.plot_factory

`create_bar_plot`
=================
Expand All @@ -30,24 +30,32 @@ Plot Factories
.. autofunction:: add_default_grids


.. currentmodule:: chaco.abstract_plot_data

:class:`AbstractPlotData`
=========================
.. autoclass:: AbstractPlotData
:members:
:show-inheritance:

.. currentmodule:: chaco.array_plot_data

:class:`ArrayPlotData`
======================
.. autoclass:: ArrayPlotData
:members:
:show-inheritance:

.. currentmodule:: chaco.plot

:class:`Plot`
=============
.. autoclass:: Plot
:members:
:show-inheritance:

.. currentmodule:: chaco.toolbar_plot

:class:`ToolbarPlot`
====================
.. autoclass:: ToolbarPlot
Expand Down
Loading