Skip to content

[fbgemm_gpu][docs] Documentation build infrastructure improvements #2249

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

Closed
wants to merge 1 commit into from

Conversation

q10
Copy link
Contributor

@q10 q10 commented Jan 4, 2024

  • Add proper linting support to the documentation build

  • Enforce linting, and add a nitpick.ignore to ignore Sphinx warnings that are not addressable

  • Remove macro prefixes from function signatures in Doxygen-generated documentation

  • Add documentation on adding Sphinx and Python docstrings

Copy link

netlify bot commented Jan 4, 2024

Deploy Preview for pytorch-fbgemm-docs ready!

Name Link
🔨 Latest commit 5090ec2
🔍 Latest deploy log https://app.netlify.com/sites/pytorch-fbgemm-docs/deploys/6599bca379522500086a1a97
😎 Deploy Preview https://deploy-preview-2249--pytorch-fbgemm-docs.netlify.app/general/documentation
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@q10 q10 force-pushed the bm/docs-6 branch 7 times, most recently from 5415a37 to a025084 Compare January 6, 2024 19:48
@q10 q10 changed the title wip [fbgemm_gpu][docs] Documentation build infrastructure improvements Jan 6, 2024
- Add proper linting support to the documentation build

- Enforce linting, and add a `nitpick.ignore` to ignore Sphinx warnings that are not addressable

- Remove macro prefixes from function signatures in Doxygen-generated documentation

- Add documentation on adding Sphinx and Python docstrings
@facebook-github-bot
Copy link
Contributor

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

@facebook-github-bot
Copy link
Contributor

@q10 merged this pull request in 3f3bf0a.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants