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.

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

Migrate sdl2.ext docs to inline SphinxDoc style #187

Open
14 of 20 tasks
a-hurst opened this issue Jul 22, 2021 · 0 comments
Open
14 of 20 tasks

Migrate sdl2.ext docs to inline SphinxDoc style #187

a-hurst opened this issue Jul 22, 2021 · 0 comments

Comments

@a-hurst
Copy link
Member

a-hurst commented Jul 22, 2021

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant