bskinn / stdio-mgr

Context manager for mocking/wrapping stdin/stdout/stderr

MIT License

14 stars 4 forks source link

DOC: Add initial Sphinx framework #56

Closed bskinn closed 5 years ago

bskinn commented 5 years ago

Plus Sphinx to requirements and 'doc' to .gitignore

Starts the process of #35.

Will definitely want a relatively robust user guide by the 2.0 release, though.

codecov-io commented 5 years ago

Codecov Report

Merging #56 into master will not change coverage. The diff coverage is n/a.

@@          Coverage Diff          @@
##           master    #56   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           3      3           
  Lines          81     81           
=====================================
  Hits           81     81

Impacted Files	Coverage Δ
src/stdio_mgr/stdio_mgr.py	`100% <ø> (ø)`	:arrow_up:

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 f5fa2bd...92b3a90. Read the comment docs.

bskinn commented 5 years ago

@jayvdb, the stub docset is in place, and Azure is set up to cover it.

A bunch of occurrences of :cls:`...` need to be switched to :class:`...`, and there are some broken cross-reference links that need debugging.

Do you want me to fix them in this branch/PR?

Do you want to fix them in a commit on this PR? (This should preserve blame?)

Or, should I just merge to master regardless of the failing Azure job, and then you can open your own branch to fix?

jayvdb commented 5 years ago

Looking now..

jayvdb commented 5 years ago

Ya, please fix them here, up to you how. Very minor silly mistake that doesnt have a high impact on using blame, which is more commonly needed to navigate history of the code (esp with bisect) rather than changes in docstrings.

jayvdb commented 5 years ago

Very glad to have this in place, so I dont make more silly mistakes like that!

bskinn commented 5 years ago

Ok, will do.

And yeah, I really should have put doctests &c in my CI on all my projects long before now -- even for as long as I've been using Sphinx, I still get stuff like this wrong a lot.