Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[WIP] Redocument and refactor the sdl2.ext API #191

Closed
wants to merge 40 commits into from

Conversation

a-hurst
Copy link
Member

@a-hurst a-hurst commented Aug 14, 2021

PR Description

Closes #187 and cleans up/fixes a whole ton of other stuff. Basically, this PR started as merging the existing .rst ext docs into the existing inline docs and migrating to Sphinx autodoc, but quickly expanded into massively expanding and rewriting the documentation, and rewriting/reorganizing various parts of the ext module.

Currently a work in progress, but most of the key modules have been refactored and redocumented.

Merge Checklist

  • the PR has been reviewed and all comments are resolved
  • all CI checks pass
  • (if applicable): the PR description includes the phrase closes #<issue-number> to automatically close an issue
  • (if applicable): bug fixes, new features, or API changes are documented in news.rst

@a-hurst a-hurst marked this pull request as draft August 14, 2021 02:26
@a-hurst
Copy link
Member Author

a-hurst commented Jan 11, 2022

This has been fully split and merged into smaller PRs, so it can be closed now.

@a-hurst a-hurst closed this Jan 11, 2022
@a-hurst a-hurst deleted the update_sphinxdoc branch July 21, 2022 20:21
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate sdl2.ext docs to inline SphinxDoc style
1 participant