Conversation
|
This is awesome! I had been dabbling with something similar in #30, but this is much more complete. cc @xgess A couple of notes on the PR for @finnkauski:
A couple of notes for us to keep track of Keybase things to do before merging:
|
|
You can add the types I suppose. I left the docs unfilled hoping that you would do it. You can add docs for each and it will include them. The obvious issue is the regeneration of new types and their docs getting deleted. I havent used whatever you used to generate the types and haven't dug around in the actual code yet (what is that by the way?) |
|
Sorry last comment. There is a PEP dictating docstring formats that covers types nicely and I think some type checkers could probably parse that. So you could include the type information withing the docs. 2 birds etc. |
Reason for PR
Had some spare time and wanted to help out some project and since I started using keybase recently and am a
pythonperson 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 Docstheme in the main folder underdocsHappy to discuss further if any changes have to be made.
What I did do
sphinx.ext.napoleonto see the format click hereread the docs themefor sphinx is also very customisable check their docs outdocsrcfolder as a storage for docs and for the temporary folder while building the files and then moves them over to thedocsfolderWhat I DID NOT do