Deploy the Docs

The docs are displayed as part of the gh-pages branch on the github repository. Don’t touch it though! Follow these steps

  1. Commit all docs changes in main.

  2. Checkout gh-pages

  3. git merge main into gh-pages

  4. Run the update_docs bash script. It compiles the html, moves the html files to the docs folder because GitHub needs that, and pushes it to the repo.

  5. Checkout main

That’s it! You can go to the online link in a few minutes or watch it deploy on github actions. See the link here: https://manishrv123.github.io/MLDjango/

It is setup on github in Settings -> Pages. It makes more sense once you check that out.