search

voith / eth-tester-rpc

Rewrite of piper merriams eth-testrpc
MIT License
3 stars 3 forks source link

add docs #6

Open voith opened 5 years ago

voith commented 5 years ago

What was wrong?

There is no Documentation at the moment

How can it be fixed?

Add documentation. For now just adding a few lines in README.md will do.

mbeacom commented 5 years ago

Glad to see things progressing here!

You could check out mkdoc and pydoc-markdown (to generate code documentation via docstrings). We're using both for: https://docs.gitcoin.co with the mkdocs-material theme.

https://github.com/gitcoinco/web/blob/master/pydocmd.yml if you opt for pydoc docstring/doc generation.

voith commented 5 years ago

Thanks for the suggestion @mbeacom. Will try to use autodocs wherever possible. However this project doesn't really have much of a public API to expose. Mainly, it has a command to start a server and then just make calls the way you'd call any JsonRPCAPI exposed by ethereum nodes.

Just FYI, this tool will be integrated in populus 3.0:

with project.get_chain('testrpc'):
   # do something