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 tons of docs #88

Closed
wants to merge 1 commit into from
Closed

Add tons of docs #88

wants to merge 1 commit into from

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Jul 19, 2024

This PR adds a lot of docs. In particular:

  • Revamp of the home / index page
  • Document all of SimpleVideoDecoder, Frame, FrameBatch, and StreamMetadata
  • Add basic installation guide
  • Add glossary of terms.

Download built docs here for a preview.

The home page now looks like this

hompage

The API ref looks liks this

apiref

And the SimpleVideoDecoder docstring looks like this

videodecoder

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jul 19, 2024
@facebook-github-bot
Copy link
Contributor

@NicolasHug has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

@facebook-github-bot
Copy link
Contributor

@NicolasHug merged this pull request in 140ece6.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot. Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants