Deploying Your Documentation to GitHub
Deploy Your Documentation to GitHub. GitHub repositories automatically serve static content when committed to a branch named
gh-pages. MkDocs makes use of that and allows you to build and deploy your project documentation in a single step.
00:46 To explore your project documentation online, head over to your browser and visit the URL that’s shown in your terminal output. If you get a 404 error when visiting the URL, take it as an opportunity for a quick break.
01:02 It can take up to ten minutes until your documentation goes live when you create or publish your GitHub Pages site. Good work. You’ve now got a well-structured base for your project documentation, which is partly auto-generated from your docstrings using mkdocstrings, and built for front-end consumption with MkDocs.
Become a Member to join the conversation.