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

Create full RTD documentation #35

Open
bskinn opened this issue Aug 3, 2019 · 1 comment
Open

Create full RTD documentation #35

bskinn opened this issue Aug 3, 2019 · 1 comment
Assignees
Labels
doc Changes/additions to the project documentation
Milestone

Comments

@bskinn
Copy link
Owner

bskinn commented Aug 3, 2019

Per here

@bskinn bskinn added the doc Changes/additions to the project documentation label Aug 3, 2019
@bskinn bskinn added this to the v2.0 milestone Aug 3, 2019
@bskinn bskinn self-assigned this Aug 3, 2019
bskinn added a commit that referenced this issue Aug 6, 2019
Use base TextIOWrapper for stdout and stderr

Plus substantial expansion of the inheritance model to provide safe closure, `.getvalue()` behavior, and buffer content retention on stdout & stderr mocks.

Docstrings updated, but need to be checked for content & cross-reference syntax; this to be done in the course of #35.

Tests added, but need inspection and probably expansion. Plan to rerun mutmut in #44.
@jayvdb
Copy link
Contributor

jayvdb commented Sep 6, 2019

https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html looks like it would be useful.

And https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html could be used directly if there isnt an existing Sphinx plugin which does a good job.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Changes/additions to the project documentation
Projects
None yet
Development

No branches or pull requests

2 participants