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.
Reason for PR
Had some spare time and wanted to help out some project and since I started using keybase recently and am a
python
person I decided to make a contribution.What this PR adds
I've set up the documentation generation using sphinx in python. Now you can simply run the
make documentation
(tested on MacOS but should work on linux) and it will build the HTML documentations using theRead the Docs
theme in the main folder underdocs
Happy to discuss further if any changes have to be made.
What I did do
sphinx.ext.napoleon
to see the format click hereread the docs theme
for sphinx is also very customisable check their docs outdocsrc
folder as a storage for docs and for the temporary folder while building the files and then moves them over to thedocs
folderWhat I DID NOT do