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.

Sign up for GitHub

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

Jump to bottom

[DOC] - Add automatic documentation generation for Solidity files using Sphinx #17

Open
mr-ubik opened this issue Aug 6, 2020 · 1 comment · May be fixed by #18
Open

[DOC] - Add automatic documentation generation for Solidity files using Sphinx #17

mr-ubik opened this issue Aug 6, 2020 · 1 comment · May be fixed by #18
Assignees
@mr-ubik
Labels
Blocked Blocked by something else Documentation Improvements or additions to documentation

Comments

@mr-ubik
Copy link
Contributor

mr-ubik commented Aug 6, 2020

Sphinx supports Solidity via this extension

Solidity docstrings follow this style
@mr-ubik mr-ubik added the Documentation Improvements or additions to documentation label Aug 6, 2020
@mr-ubik mr-ubik self-assigned this Aug 6, 2020
@mr-ubik mr-ubik changed the title [DOC] Add automatic documentation generation for Solidity files using Sphinx [DOC] - Add automatic documentation generation for Solidity files using Sphinx Aug 6, 2020
@mr-ubik mr-ubik linked a pull request Aug 7, 2020 that will close this issue
Draft
@mr-ubik
Copy link
Contributor Author

mr-ubik commented Aug 28, 2020

Update: After the experiment on UniFi, it has become clear that there's no valid out of the box solution for the entire documentation pipeline.

@mr-ubik mr-ubik added the Blocked Blocked by something else label Aug 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mr-ubik mr-ubik

Labels
Blocked Blocked by something else Documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Sphinx configuration EthereansOS/Organizations-Interface
1 participant
@mr-ubik