Skip to content

Documentation for SDL2_mixer/SDL2_ttf/SDL2_image extremely out of date #160

Open
@a-hurst

Description

@a-hurst

The official documentation sites for the mixer, ttf, and image projects are now more than a decade out of date, having last been generated in 2009 (since before SDL2 was even released). More recent documentation can be found in the actual header files (still not entirely up to date in some cases), but that's pretty arcane for people trying to figure out 1) what functions are actually available in a Python wrapper around the libraries and 2) how those functions actually work. Thus, even though this technically isn't our fault or responsibility, I feel like it might be worth it to document these libraries in the official PySDL2 docs.

To facilitate this, I partially wrote a regex script that spits out .rst files from the SDL2 headers based on function definitions and corresponding comments, which should automate a lot of the grunt work here. Still, it's going to be a bit of work.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions