Skip to content
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

Convert documentation to ReadTheDocs #124

Open
pipermerriam opened this issue Aug 19, 2018 · 2 comments
Open

Convert documentation to ReadTheDocs #124

pipermerriam opened this issue Aug 19, 2018 · 2 comments

Comments

@pipermerriam
Copy link
Member

What was wrong?

Docs are currently only in the README.

How can it be fixed?

Convert documentation to be sphinx based and host on readthedocs.

@carver
Copy link
Contributor

carver commented Nov 16, 2018

While converting to RTD, we got some reasonable feedback at Devcon4 about what's not working well, currently:

The quick start doesn't actually show how to instantiate a contract or call contract methods, just send basic transactions. Compare that with the documentation on pyethereum tester, which, while extremely scant and not nearly verbose enough, at least tells you how to do what you want to do: https://github.com/ethereum/pyethereum/wiki/Using-pyethereum.tester

Yup, definitely need more content here.

The Eth-Tester readme is also too long and doesn't actually tell you anything. For example, I can read the source if I want to know what the function parameters are to the EthereumTester.take_snapshot function - that level of documentation belongs in the docstring above the function NOT in a ReadMe.

I think the best way to do this is to add docstrings, and have those get auto-inserted into the RTD API docs. So we will end up with low-level docs in RTD, but they will be auto-generated from the source docs.

@pipermerriam
Copy link
Member Author

cc @AKewlBreeze this might be a good one for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants