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

Making a bot which posts the documentation page in htlm if a pull request changed it #12382

Closed
gabrieldemarmiesse opened this issue Mar 2, 2019 · 1 comment
Labels
stat:contributions welcome A pull request to fix this issue would be welcome.

Comments

@gabrieldemarmiesse
Copy link
Contributor

If someone makes a PR which changes the documentation, a bot should build the documentation and comment on the pull request with the html page rendered as pdf. This should allow PR reviewers to see very quickly if there is a problem of formatting, and it would be easy to fix it early. That would make huge time savings in the long run.

Nearly all CI projects authorize using docker and https://github.com/arachnys/athenapdf seems good enough to convert html to PDF. Furthermore pygithub is a very cool package allowing to interact with github super easily with python (ideal to make bots).

Those tools should make the task not easy, but at least feasable given enough time.

This issue is also valid for keras-contrib, see keras-team/keras-contrib#472

@gabrieldemarmiesse gabrieldemarmiesse added Enhancement stat:contributions welcome A pull request to fix this issue would be welcome. labels Mar 2, 2019
@JoshuaRM
Copy link
Contributor

Is this still available? I think this would be similar to the bot you have created, please let me know if I can work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stat:contributions welcome A pull request to fix this issue would be welcome.
Projects
None yet
Development

No branches or pull requests

3 participants