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

Automate docs generation using solidity-docgen. #751

Closed
1 task done
ealmansi opened this issue Feb 16, 2018 · 4 comments
Closed
1 task done

Automate docs generation using solidity-docgen. #751

ealmansi opened this issue Feb 16, 2018 · 4 comments
Labels
automation Tests and coverage running. Docsite publishing. documentation Inline comments, guides, and examples.

Comments

@ealmansi
Copy link
Contributor

ealmansi commented Feb 16, 2018

🎉 Description

Documentation is currently generated manually by running the solidity-docgen project. It would be great if we automated this process as part of the build step on every major and minor version update.

  • 📈 This is a feature request.
@ealmansi
Copy link
Contributor Author

cc @ajsantander

@eordano
Copy link
Contributor

eordano commented May 29, 2018

Not sure about this: It would pollute the repository with generated files. Perhaps after dev installs? What if instead the documentation is published to github pages?

@frangio frangio added documentation Inline comments, guides, and examples. automation Tests and coverage running. Docsite publishing. and removed chore labels Jul 20, 2018
@nventuro
Copy link
Contributor

nventuro commented Mar 8, 2019

This is already happening as part of the docsite revamp @frangio is carrying out.

@nventuro nventuro closed this as completed Mar 8, 2019
@frangio
Copy link
Contributor

frangio commented Mar 12, 2019

To be clear, this is already happening today. The docsite is deployed automatically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation Tests and coverage running. Docsite publishing. documentation Inline comments, guides, and examples.
Projects
None yet
Development

No branches or pull requests

5 participants