search

kostaleonard / mlops

A framework for conducting MLOps.
MIT License
3 stars 0 forks source link

Create GitHub pages site #31

Closed kostaleonard closed 2 years ago

kostaleonard commented 2 years ago

Create a GitHub pages site for the project documentation.

kostaleonard commented 2 years ago

Originally what I wanted to do was have the root README be the site's index content, and then have a link somewhere on that page that went to the root of the auto-generated sphinx docs. I am not sure how that could be done. The design pattern I have seen instead is that the GitHub pages content is hosted from a separate branch in the repository that is basically just web content. I have some reservations about that strategy (what if I accidentally merge the pages branch into main--that would be a mess), but it could be an easier way to host the project docs.

kostaleonard commented 2 years ago

This was addressed in #32 but pages only get rebuilt on release. Next time there is a release, check that the pages have been updated correctly (check the version).

kostaleonard commented 2 years ago

Verified in #34