Merge API documentation in Sphinx with docstrings #126
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
For your reviewing benefit, a PDF render. |
|
I have no idea how hard this rebase is going to be, but there's a merge conflict :( |
|
oh yeah, this looks interesting. please rebase. 🐶 |
|
could you also fix in |
| :py:class:`CRL` :py:class:`CRLType` | ||
| ========================= ============================= | ||
|
|
||
| Some objects, such as py:class`Revoked`, don't have ``Type`` |
There was a problem hiding this comment.
broken markup (missing : before py)
|
That’s all I could find. Maybe after you’ve fixed those, @reaperhulk or @alex can eyeball the docs too if I’ve missed something and then we can merge. :) |
|
Thanks for the review, @hynek! I've addressed all comments. |
2 similar comments
2 similar comments
4 similar comments
|
hm, why did coverage decrease by 2.35%? :( |
|
Bump, I would really like to merge this so that new API entries in other PRs can use this. Any idea why the coverage decreased? :-/ |
hynek
added a commit
that referenced
this pull request
May 6, 2015
Merge API documentation in Sphinx with docstrings
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Major improvements to the docstrings (mostly by merging the information that was only in Sphinx, but also grammar fixes).
This isn't entirely complete: sign, verify, PKCS7... still have their own API docs in Sphinx. But hey, this PR is already more than big enough (thanks @alex for nudging me to send it in quicker).
This fixes #125, too.