Skip to content

Commit

Permalink
Documentation Refactor (#462)
Browse files Browse the repository at this point in the history
* Update configuration; use Enthought sphinx template if available.

* [WIP] new content, some re-organizaition of existing content

* Update license dates.

* [WIP] Start developer reference proper.

* More WIP

* Add index for api docs.

* FIX: Add missing imports to api

Adds missing imports of SegmentPlot and TextPlot to api.py.

* DOC: Fix missing link warnings

* DOX: Fix line header length warnings

* DOC: Fix missing link to installation instructions

* DOC: Remove link to Enthought wiki

* DOC: Fix broken link to mappers

* DOC: Fix broken formatting in renderer index

* DOC: Remove empty tutorial_wx file

* DOC: Mark already-referenced as :orphan:

Mark index documents are orphans to silence warnings that they aren't
included in any TOC.

* DOC: Fix RST link in ToolbarPlot

* DOC: CLN: Remove links to old webinars

* DOC: CLN: Remove resource.rst and move contents

Remove the `user_guide/resource.rst` because it only contained redundant
contents and broken links. The only relevant bit of text was about the
SciPy 2008 tutorial, which is covered by `chaco_tutorial.rst` so I moved
some of the text there.

* CLN: Remove and update links to code.enthought.com

Either point to a different location if relevant, or straight out remove
the link if it's broken.

* DOC: CLN: Fix warnings to unescaped * and broken link

* DOC: Link tutorials from User Guide

* DOC: Fix layout of modules_and_classes

* DOC: Move programmers_reference documents into user guide

* DOC: Clean up quickstart for formatting and links

* DOC: Use proper TOC for How do I

* DOC: Fix indentation in quickstart

* DOC: Move architecture_overview to dev reference

Move the architecture_overview doc to developer_reference, and move some
of the contents into the introduction document.

* DOC: Fix RST in data_sources

* FIX: Fix circular import in transform_color_mapper

The fix is to import ColorMapper directly from chaco.color_mapper

* DOC:CLN: Remove mention of PolarMapper

* DOC: Fix RST links for data sources

* DOC: Fix RST links for mappers

* DOC: Fix RST links for data ranges

* DOC: Fix RST links for plot types and renderers

* FIX: Circular import in toolbar_plot

* DOC: Fix API doc links for plot_factories

* FIX: Circular imports in tools

I used .imports to be consistent with other files in the chaco.tools.

* DOC: Fix API doc links for tools

* DOC: Fix API doc links for axis.rst

* DOC: Fix API doc links for visual components

* DOC: Fix API doc links for containers

* DOC: Add support for intersphinx for enable

* DOC: Add missing MinorPlotAxis to API docs

* DOC: Fix RST formatting

* DOC: Add curstor tools to API docs

* DOC: Add SelectableLegend to API docs

* DOC: Fix API links in user guide

* DOC: Fix formatting in quickstart

* Add Quickstart to userguide

* DOC: Use unique RST name for API docs

* DOC: Link to PDF version of 2008 tutorial slides

* Remove duplicate entry in user_guide/index

* FIX: Enable disabling sidebar with new theme

* fix broken links and typos in fundamentals.rst

* bunch more typo and broken link fixes

* more typos and links

* more clean up, remove repeated sections

* remove empty sections of user guide introduction (they are covered later in the user guide)

* re-order usermanual a bit

* tools and overlays are on separate pages

* tool page title fix

* suggest pyqt5 not pyqt

* remove duplicated paragraph

* have list of pages att end of intro match pages of user guide (although I'm not entirely sure we need the links in the intro at all)

* move tools.rst into basic elements

* remove redudant tutorials_and_examples.rst from user guide. Tutorials are alrady linked from home page of docs

* move quickstart.rst into use_manual as that is where it is now used

* make Overays page title a higherr level heading

Co-authored-by: Alexandre Chabot-Leclerc <achabot@enthought.com>
Co-authored-by: Tim Diller <tdiller@enthought.com>
Co-authored-by: Aaron Ayres <aayres@enthought.com>
Co-authored-by: aaronayres35 <36972686+aaronayres35@users.noreply.github.com>
  • Loading branch information
5 people authored Mar 30, 2021
1 parent 2d36abd commit 174342f
Show file tree
Hide file tree
Showing 34 changed files with 2,616 additions and 1,364 deletions.
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

0 comments on commit 174342f

Please sign in to comment.