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

Add Sound page to the Programming Guide #1922

Merged

Conversation

pushfoo
Copy link
Member

@pushfoo pushfoo commented Oct 7, 2023

Closes #1274
Closes #1900

Changes

  1. Add link targets to the platformer tutorial
  2. Add new Sound page to the programming guide covering usage and compatibility
  3. Link the Sound page from the top-level index

How to Test

  1. Clone the branch locally
  2. Run pip install -I -e .[dev] to make sure you have the dev dependencies fully installed & upgraded
  3. ./make.py html (optional, but helps prevent an occasional rebuild loop)
  4. ./make.py serve
  5. Open https://localhost:8000 in your browser
  6. Verify the page is in the sidebar and Programming Guide homepage section
  7. Open http://localhost:8000/programming_guide/sound.html
  8. Proof-read the Sound Basics sections brutally:
  9. Verify that #1900 is covered by http://localhost:8000/programming_guide/sound.html#backends-determine-playback-features
  10. If time / interest allow, proof read and verify other parts

Follow-up work for future PRs

  1. Move some of the preloading concepts to a new performance page / heading
  2. Add an easier to digest reference counting section somewhere and link it instead of the Python contributor doc
  3. Move some compatibility information to its own page / heading

@pushfoo
Copy link
Member Author

pushfoo commented Oct 7, 2023

@DavidEBrumbaugh Since you were the initial reporter for pyglet/pyglet#952, would you be up for building the doc locally and previewing it? I've updated the test steps with instructions for doing so.

* Add Player methods to the table, including seek with a warning

* Change some titles related to changing playback aspects

* Add link targets for changing playback

* Rewrite a few intros / sections

* Replace footnotes sectin in Use Streaming Sparingly
@pushfoo pushfoo force-pushed the add_sound_programming_guide_page branch from 8a178b2 to 4ca4eed Compare October 7, 2023 12:16
* Shorted some sections

* Add brief example code
* Move first mention of garbage collection to advanced

* Remove some wording

* Split up big example code block
doc/programming_guide/sound.rst Outdated Show resolved Hide resolved
doc/programming_guide/sound.rst Outdated Show resolved Hide resolved
doc/programming_guide/sound.rst Outdated Show resolved Hide resolved
doc/programming_guide/sound.rst Show resolved Hide resolved
doc/programming_guide/sound.rst Show resolved Hide resolved
doc/programming_guide/sound.rst Outdated Show resolved Hide resolved
@DavidEBrumbaugh
Copy link

DavidEBrumbaugh commented Nov 5, 2023 via email

@pushfoo pushfoo requested a review from pvcraven November 5, 2023 01:19
@pushfoo
Copy link
Member Author

pushfoo commented Nov 5, 2023

@DavidEBrumbaugh

I would appreciate it if you could verify the PulseAudio crash you reported is adequately covered by the Backends Determine Playback Features heading.

The doc about the crash will be relevant for another few months at the minimum. Although it seems like there is a fix in the works, it sounds like it may be delayed until pyglet 2.2.

If you're travelling without access to a fast connection, this may be the easiest approach:

  1. Wait for this to merge
  2. Wait for the readthedocs build to complete & add the new page
  3. Once the build finishes, check the Backends Determine Playback Features heading at https://api.arcade.academy/en/development/programming_guide/sound.html (won't exist until this is merged & built)

@pvcraven pvcraven merged commit aeb551c into pythonarcade:development Nov 5, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document PulseAudio crash + workarounds Documentation: Sound compatibility recommendations
3 participants