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

Updated docs for v2 #111

Merged
merged 13 commits into from
Oct 9, 2020
Merged

Updated docs for v2 #111

merged 13 commits into from
Oct 9, 2020

Conversation

tarkatronic
Copy link
Contributor

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 the click command, for the Usage 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 the README.md. Not sure what to do there yet.
  • sphinxcontrib-spelling -- A spellchecker! Yay! This also meant setting up a custom word list under docs/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/

@tarkatronic tarkatronic added the documentation Improvements or additions to documentation label Oct 7, 2020
@codecov
Copy link

codecov bot commented Oct 7, 2020

Codecov Report

Merging #111 into master will increase coverage by 6.52%.
The diff coverage is n/a.

Impacted file tree graph

@@             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     
Impacted Files Coverage Δ
tartufo/scanner.py
tartufo/__main__.py
tartufo/util.py
tartufo/config.py
tartufo/types.py

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a345eb9...29740a3. Read the comment docs.

Copy link
Contributor

@mxhenry-godaddy mxhenry-godaddy left a 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.

docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Show resolved Hide resolved
Copy link
Contributor

@sjacoby-godaddy sjacoby-godaddy left a 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!

@tarkatronic tarkatronic merged commit 9d20e1b into master Oct 9, 2020
@tarkatronic tarkatronic deleted the v2-docs branch October 9, 2020 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The current documentation is fragmented, scattered, and confusing Consider using sphinx-click
6 participants