Integrate the documentation generation into the CI pipeline

tbenthompson / cutde

Python CPU and GPU accelerated TDEs, over 100 million TDEs per second!

MIT License

58 stars 15 forks source link

Integrate the documentation generation into the CI pipeline #4

Open tbenthompson opened 3 years ago

tbenthompson commented 3 years ago

It's not a perfect fit because the generated readme needs to be in the git repo but I don't want to be committing from the CI server. One solution is to have the CI generate the readme and if there's any diff with the existing readme, then fail the tests. Another solution would be to have the same check in pre-commit.

tbenthompson commented 3 years ago

I just noticed that the example.py code was out of date with respect to the rest of the package and that was causing bugs. Catching this earlier via CI would be nice.