Use sphinx todo for currently empty sections of docs (#654)

* remove some empty sections with todos (this creates new sphinx warnings currently) * add todos in overlays * comment out section titles to avod warnings
enthought · Apr 21, 2021 · 68fdf0e · 68fdf0e
1 parent 7c12d9e
commit 68fdf0e
Show file tree

Hide file tree

Showing 5 changed files with 117 additions and 103 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,6 +32,7 @@ def get_build_docset():
   'sphinx.ext.napoleon',
   'sphinx.ext.graphviz',
   'sphinx.ext.intersphinx',
+  'sphinx.ext.todo',
   'traits.util.trait_documenter',
 ]
 

diff --git a/docs/source/user_manual/basic_elements/overlays.rst b/docs/source/user_manual/basic_elements/overlays.rst
@@ -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:
 
@@ -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
+..    =========
diff --git a/docs/source/user_manual/basic_elements/tools.rst b/docs/source/user_manual/basic_elements/tools.rst
@@ -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
 ==================
@@ -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
+..    ===============
diff --git a/docs/source/user_manual/common_patterns.rst b/docs/source/user_manual/common_patterns.rst
@@ -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
+..    ===================================
 
 
diff --git a/docs/source/user_manual/how_do_i.rst b/docs/source/user_manual/how_do_i.rst
@@ -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?
 -----------------------------------------
@@ -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?
 ----------------------------
@@ -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?