-
Notifications
You must be signed in to change notification settings - Fork 71
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
Updated docs for v2 #111
Updated docs for v2 #111
Conversation
Codecov Report
@@ Coverage Diff @@
## master #111 +/- ##
===========================================
+ Coverage 93.47% 100.00% +6.52%
===========================================
Files 9 3 -6
Lines 567 75 -492
Branches 101 5 -96
===========================================
- Hits 530 75 -455
+ Misses 32 0 -32
+ Partials 5 0 -5
Continue to review full report at Codecov.
|
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.
Love the wordsmithing and things are very clear. Just a few nitpicks.
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.
looks great, ship it!
This is, hopefully, the last thing needed in the lead-up to v2.0.0 final!
Fixes #74
Fixes #75
This ended up, largely, being a rewrite and cleanup of the documentation. The hope is that the structure overall makes more sense and information is more readily available, easier to find, and automatically up-to-date.
I added 2 Sphinx modules:
sphinx-click
-- This automatically extracts the full usage of theclick
command, for theUsage
document. This way we don't have to remember to copy-paste it into there every time usage changes. NOTE: This does not, however, fix that need for theREADME.md
. Not sure what to do there yet.sphinxcontrib-spelling
-- A spellchecker! Yay! This also meant setting up a custom word list underdocs/source/spelling_wordlist.txt
, for words that we know are definitely spelled right, but aren't in the default dictionary.Possibly the easiest way to review these will be with the fully rendered version, so I've activated this branch over on ReadTheDocs (although it is hidden from the version menu). You can find it here: https://tartufo.readthedocs.io/en/v2-docs/