-
Notifications
You must be signed in to change notification settings - Fork 62
Add documentation with MkDocs #85
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
base: master
Are you sure you want to change the base?
Add documentation with MkDocs #85
Conversation
As a matter of preference I'd vote to preserve the nesting of |
I had actually included the wrong modules, but it is fixed now. Now only the correct classes for the correct module are included, and the page is not nearly as long. |
This PR adds guide and API documentation using MkDocs.
Depending on how much time the decision makers want me to spend, I can fix MarkDown formatting issues. Until then, the docs contained herein are still usable.
Only modules written in Python are included. Modules coming from protocol buffers are not included.
A preview can be found here.