Add sphinxcontrib spelling instructions - Githubissues

pytorch / opacus

Training PyTorch models with differential privacy

https://opacus.ai

Apache License 2.0

1.68k stars 334 forks source link

Add sphinxcontrib spelling instructions #488

Closed zycalice closed 2 years ago

zycalice commented 2 years ago

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[x] Docs change / refactoring / dependency upgrade

Motivation and Context / Related issue

Added instructions on how to perform spell checks on documentations built through Sphinx. The package is called sphinxcontrib-spelling.

Related to https://github.com/pytorch/opacus/issues/380

How Has This Been Tested (if it applies)

Documentation update

Checklist

[x] The documentation is up-to-date with the changes I made.
[x] I have read the CONTRIBUTING document and completed the CLA (see CONTRIBUTING).
[ ] All tests passed, and additional code has been covered with new tests.

facebook-github-bot commented 2 years ago

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