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 minimal doc setup, doc build CI job and README #36

Closed
wants to merge 5 commits into from

Conversation

NicolasHug
Copy link
Member

@NicolasHug NicolasHug commented Jun 15, 2024

This PR adds:

  • Very basic docs
  • A doc build setup (taken and simplified from torchvision).
  • A doc build CI job - you can verify that it works here and if you go on the "summary" tab you can download the built docs artifacts at the bottom of the page.
  • A placeholder README with some basic OSS dev instructions

For reviewers: feel free to ask questions about how this works but for now, please just trust me on this. The only thing you need to review, if you want to, is the placeholder README.

There will be a lot of follow-up PRs related to the docs, namely:

  • Introducing sphinx-gallery
  • some styling stuff
  • introducing a doc preview within the PR
  • writing the actual docs...
  • etc...

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Meta Open Source bot. label Jun 15, 2024
@NicolasHug NicolasHug marked this pull request as ready for review June 16, 2024 09:54
@NicolasHug NicolasHug changed the title Add minimal doc setup and doc build CI job Add minimal doc setup, doc build CI job and README Jun 16, 2024
@@ -0,0 +1,56 @@
TorchCodec
==========
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a placeholder README for now with the bare minimum info to get devs started on the OSS workflow. We'll organize and structure it differently soon.

@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 has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

1 similar comment
@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 45d5c28.

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