Skip to content

Migrate sdl2.ext docs to inline SphinxDoc style #187

Open
@a-hurst

Description

@a-hurst

Currently, the primary docs for all the sdl2.ext modules are in separate .rst files instead of being in-line with their corresponding code. This makes the docs much harder to maintain, and also makes the code itself harder to read. To address this, we'll migrate the docs for these modules over to Google-style or Numpy-style inline sphinxdoc style.

Documentation to migrate

  • sdl2.rst
  • sdl2ext.rst
  • sdl2ext_algorithms.rst
  • sdl2ext_array.rst
  • sdl2ext_color.rst
  • sdl2ext_colorpalettes.rst
  • sdl2ext_common.rst
  • sdl2ext_compat.rst
  • sdl2ext_draw.rst
  • sdl2ext_ebs.rst
  • sdl2ext_events.rst
  • sdl2ext_font.rst
  • sdl2ext_gui.rst
  • sdl2ext_image.rst
  • sdl2ext_particles.rst
  • sdl2ext_pixelaccess.rst
  • sdl2ext_resources.rst
  • sdl2ext_sprite.rst
  • sdl2ext_surface.rst
  • sdl2ext_window.rst

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions