Skip to content
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

Jump to bottom

Use sphinx todo for currently empty sections of docs #654

Merged
merged 4 commits into from
Apr 21, 2021
Merged

Use sphinx todo for currently empty sections of docs #654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4411749
remove some empty sections with todos (this creates new sphinx warnin…
aaronayres35 Apr 12, 2021
6f0f750
add todos in overlays
aaronayres35 Apr 12, 2021
75bb09a
comment out section titles to avod warnings
aaronayres35 Apr 16, 2021
0751691
Merge branch 'master' into use-sphinx-todo
aaronayres35 Apr 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ def get_build_docset():
'sphinx.ext.napoleon',
'sphinx.ext.graphviz',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'traits.util.trait_documenter',
]

Expand Down
37 changes: 20 additions & 17 deletions docs/source/user_manual/basic_elements/overlays.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,25 +154,27 @@ Events
:attr:`~chaco.axis.PlotAxis.updated`
Fired when the axis's range bounds change.

.. _legend:
.. todo:: Fill in the below sections

Legend
======
.. .. _legend:

.. _grid:
.. Legend
.. ======

Grid
====
.. .. _grid:

.. Grid
.. ====

===================
Annotation Overlays
===================
.. ===================
.. Annotation Overlays
.. ===================

PointMarker
===========
.. PointMarker
.. ===========

DataBox
=======
.. DataBox
.. =======

.. _tools/text_box_overlay:

Expand All @@ -197,9 +199,10 @@ The rendering of the text can be customized with the following attributes:
:meth:`request_redraw` should be called. Good examples include
:class:`chaco.overlays.api.ImageInspectorOverlay`.

.. todo:: Fill in the below sections

ToolTip
=======
.. ToolTip
.. =======

PlotLabel
=========
.. PlotLabel
.. =========
114 changes: 60 additions & 54 deletions docs/source/user_manual/basic_elements/tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,67 +2,71 @@
Tools
*****

================================================================
Overview
================================================================
.. todo:: Fill in the below sections

.. ================================================================
.. Overview
.. ================================================================

Chaco, Enable, and Event Dispatch
=================================

.. Chaco, Enable, and Event Dispatch
.. =================================

A Basic Tool
============

.. A Basic Tool
.. ============

A Basic Overlay
===============

.. A Basic Overlay
.. ===============

================================================================
Interaction Tools
================================================================

PanTool
=======
.. ================================================================
.. Interaction Tools
.. ================================================================

.. PanTool
.. =======

ZoomTool
========
.. ZoomTool
.. ========

RectZoom
========
.. RectZoom
.. ========

DragZoom
========
.. DragZoom
.. ========

LegendTool
==========
.. LegendTool
.. ==========

DataLabelTool
=============
.. DataLabelTool
.. =============

MoveTool
========
.. MoveTool
.. ========


================================================================
Inspector-type Tools
================================================================

DataPrinter
===========
.. todo:: Fill in the below sections

.. DataPrinter
.. ===========

LineInspector
=============
.. LineInspector
.. =============

ScatterInspector
================
.. ScatterInspector
.. ================

CursorTool
==========
.. CursorTool
.. ==========

HighlightTool
=============
.. HighlightTool
.. =============

ImageInspectorTool
==================
Expand Down Expand Up @@ -125,32 +129,34 @@ is, and `data_value` with the scalar value being displayed in that tile.
For a complete example, see :download:`examples/demo/basic/image_inspector.py
<../../../examples/demo/basic/image_inspector.py>`.

TraitsTool
==========
.. todo:: Fill in the below sections

.. TraitsTool
.. ==========


================================================================
Selection Tools
================================================================

RangeSelection
==============
.. ================================================================
.. Selection Tools
.. ================================================================

LassoSelection
==============
.. RangeSelection
.. ==============

SelectTool
==========
.. LassoSelection
.. ==============

.. SelectTool
.. ==========


================================================================
Drawing Tools
================================================================

DrawPointsTool
==============
.. ================================================================
.. Drawing Tools
.. ================================================================

.. DrawPointsTool
.. ==============

LineSegmentTool
===============
.. LineSegmentTool
.. ===============
28 changes: 14 additions & 14 deletions docs/source/user_manual/common_patterns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
.. todo:: Fill in the below sections

=============
Common Usages
=============
.. =============
.. Common Usages
.. =============


Linking Plots
=============
.. Linking Plots
.. =============


Updating/Streaming Data
=======================
.. Updating/Streaming Data
.. =======================


Saving Screenshots
==================
.. Saving Screenshots
.. ==================


Non-interactive/Offscreen Rendering
===================================
.. Non-interactive/Offscreen Rendering
.. ===================================


Integrating with TraitsUI Controls
===================================

.. Integrating with Traits UI Controls
.. ===================================


40 changes: 22 additions & 18 deletions docs/source/user_manual/how_do_i.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ Integrate a Chaco plot into my WX app?
Note that this will require for the ETS_TOOLKIT environment variable to
be set to 'wx'.

* integrate a Chaco plot into my QT app?
.. todo::

* integrate a Chaco plot into my QT app?

Integrate a Chaco plot into my TraitsUI?
-----------------------------------------
Expand Down Expand Up @@ -163,7 +165,9 @@ Layout and Rendering

*How do I...*

* put multiple plots in a single window?
.. todo::

* put multiple plots in a single window?

Change the background color?
----------------------------
Expand Down Expand Up @@ -193,26 +197,26 @@ Turn off borders?
def change_to_borderless_plot(plot):
plot.border_visible = False

.. todo::

Writing Components
==================
.. Writing Components
.. ==================

*How do I...*
*How do I...*

* compose multiple renderers?
* write a custom renderer?
* write a custom overlay/underlay?
* write a custom tool?
* write a new container?
* compose multiple renderers?
* write a custom renderer?
* write a custom overlay/underlay?
* write a custom tool?
* write a new container?


Advanced
========

*How do I...*
.. Advanced
.. ========

* properly change/override draw dispatch?
* modify event dispatch?
* customize backbuffering?
* embed custom/native WX widgets on the plot?
*How do I...*

* properly change/override draw dispatch?
* modify event dispatch?
* customize backbuffering?
* embed custom/native WX widgets on the plot?