chore: sphinx documentation configs, build script, CI job #117
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
fubuloubu
reviewed
Aug 2, 2021
fubuloubu
reviewed
Aug 3, 2021
| @@ -0,0 +1,69 @@ | |||
| Quickstart guide | |||
There was a problem hiding this comment.
I wonder if there is a way to pull this content from the README.md?
There was a problem hiding this comment.
We could add a step to build_docs.py to do that. It would make things easier if we converted it from markdown to ReST.
lost-theory
force-pushed
the
chore/docs
branch
4 times, most recently
from
6b3602b
to
aa0e452
Compare
fubuloubu
approved these changes
Aug 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What I did
Related issue: #21
How I did it
I used some of the sphinx setup I did in eip712, but added quite a bit of work on top of that, including the sphinx-autoapi plugin so we don't have to generate or maintain
.rstfiles for full API documentation of modules, classes, and functions.How to verify it
A new CI job for docs will on PRs, branches, and releases.
Checklist