-
-
Notifications
You must be signed in to change notification settings - Fork 463
Miscellaneous documentation improvements #762
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
Miscellaneous documentation improvements #762
Conversation
Makes for easier building of documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #762 +/- ##
==========================================
+ Coverage 97.95% 98.03% +0.08%
==========================================
Files 76 76
Lines 3516 3510 -6
Branches 177 177
==========================================
- Hits 3444 3441 -3
+ Misses 43 40 -3
Partials 29 29 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
The readthedocs config should work, but we won't know for sure until this PR is merged. Looking at the long list of failed builds I don't think we'd be losing much if it doesn't work for whatever reason: https://app.readthedocs.org/projects/django-two-factor-auth/builds/ |
|
Would be nice to enable RTD pull request builds IMO. |
|
|
||
| flake8: | ||
| tox -e flake8,isort | ||
| tox -e ruff,isort |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't anything to do with documentation but it was right there looking at me so I fixed it
claudep
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wow, nice work! 👍
|
And RTD build fixed, kudos! |
Description
Fixed a few minor mistakes in documentation and did a little reformatting to make things neater. Also added a "docs" test environment to our tox configuration so developers don't have to manually install sphinx to build documentation.
Motivation and Context
While answering #761 I noticed a mistake in the documentation and while fixing that I noticed another mistake etc. etc. and now I have a handful of commits 😸
How Has This Been Tested?
Ran
make docslocally and skim read the documentation.Screenshots (if appropriate):
Types of changes
Checklist: