From d7543c8beb9f9c042431a46da80f4cbfda11efdb Mon Sep 17 00:00:00 2001 From: John Wiggins Date: Wed, 10 Mar 2021 18:42:23 +0100 Subject: [PATCH] Ignore kiva backends in the API docs --- ci/edmtool.py | 25 +++++++++--- docs/source/kiva/quickref.rst | 75 +++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+), 5 deletions(-) diff --git a/ci/edmtool.py b/ci/edmtool.py index 9f3afc5ec..9fb3c4ee6 100644 --- a/ci/edmtool.py +++ b/ci/edmtool.py @@ -246,18 +246,33 @@ def docs(runtime, toolkit, environment): "sphinx", "enthought_sphinx_theme", ]) - ignore = " ".join([ + enable_ignore = " ".join([ + "enable/gcbench", "enable/null", - "enable/pyglet_backend", "enable/qt4", "enable/savage/trait_defs/ui/qt4", "enable/savage/trait_defs/ui/wx", "enable/trait_defs/ui/qt4", "enable/trait_defs/ui/wx", - "enable/vtk_backend", "enable/wx", "*/tests", ]) + kiva_ignore = " ".join([ + "kiva/fonttools/font_manager.py", + "kiva/basecore2d.py", + "kiva/cairo.py", + "kiva/celiagg.py", + "kiva/oldagg.py", + "kiva/pdf.py", + "kiva/pdfmetrics.py", + "kiva/ps.py", + "kiva/qpainter.py", + "kiva/svg.py", + "kiva/agg", + "kiva/gl", + "kiva/quartz", + "*/tests", + ]) commands = [ "edm install -y -e {environment} " + packages, ] @@ -279,7 +294,7 @@ def docs(runtime, toolkit, environment): + api_path + " -t " + templates_path + " enable " - + ignore + + enable_ignore ] execute(commands, parameters) click.echo("Done regenerating enable API docs") @@ -289,7 +304,7 @@ def docs(runtime, toolkit, environment): + api_path + " -t " + templates_path + " kiva " - + " */tests" + + kiva_ignore ] execute(commands, parameters) click.echo("Done regenerating kiva API docs") diff --git a/docs/source/kiva/quickref.rst b/docs/source/kiva/quickref.rst index be95c47f2..81d7fde4e 100644 --- a/docs/source/kiva/quickref.rst +++ b/docs/source/kiva/quickref.rst @@ -32,29 +32,49 @@ In addtion to the ``save_state`` and ``restore_state`` methods, it is also possi to use a ``GraphicsContext`` instance as a context manager. .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.save_state + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.restore_state + :noindex: Methods controlling state ^^^^^^^^^^^^^^^^^^^^^^^^^ .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_fill_color + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_fill_color + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_stroke_color + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_stroke_color + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_line_width + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_line_join + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_line_cap + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_line_dash + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.linear_gradient + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.radial_gradient + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_alpha + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_alpha + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_antialias + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_antialias + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_miter_limit + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_flatness + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_image_interpolation + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_image_interpolation + :noindex: Current Transformation Matrix @@ -64,11 +84,17 @@ The current transformation matrix is part of the graphic state and therefore covered by calls to ``save_state()`` and ``restore_state()`` .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.translate_ctm + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.rotate_ctm + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.scale_ctm + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.concat_ctm + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_ctm + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_ctm + :noindex: Clipping functions @@ -78,9 +104,13 @@ Clipping functions All of these functions are affected by the current transformation matrix. .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.clip_to_rect + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.clip_to_rects + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.clip + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.even_odd_clip + :noindex: .. _kiva_path_functions: @@ -92,19 +122,33 @@ pen position. Many path manipulations use the current point as a starting position for the geometry which is added to the path. .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.begin_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.close_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_empty_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.add_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.move_to + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.line_to + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.lines + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.line_set + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.rect + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.rects + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.curve_to + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.quad_curve_to + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.arc + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.arc_to + :noindex: .. _kiva_drawing_functions: @@ -112,11 +156,17 @@ Drawing functions ~~~~~~~~~~~~~~~~~ .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.draw_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.fill_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.eof_fill_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.stroke_path + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.draw_rect + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.draw_image + :noindex: Enhanced drawing functions ^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -125,39 +175,64 @@ Enhanced drawing functions their presence before attempting to call them. .. automethod:: kiva.abstract_graphics_context.EnhancedAbstractGraphicsContext.draw_marker_at_points + :noindex: .. automethod:: kiva.abstract_graphics_context.EnhancedAbstractGraphicsContext.draw_path_at_points + :noindex: Text functions ~~~~~~~~~~~~~~ .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_text_drawing_mode + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_text_matrix + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_text_matrix + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_text_position + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_text_position + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.show_text + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.show_text_at_point + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_text_extent + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_full_text_extent + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_character_spacing + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_character_spacing + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.select_font + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_font + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.get_font + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.set_font_size + :noindex: Misc functions ~~~~~~~~~~~~~~ .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.width + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.height + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.flush + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.synchronize + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.begin_page + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.end_page + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.clear_rect + :noindex: .. automethod:: kiva.abstract_graphics_context.AbstractGraphicsContext.save + :noindex: Types