PYTHON — Deploy Documentation for Python on GitHub
It’s not that we use technology, we live technology. — Godfrey Reggio
PYTHON — Python Defaultdict Overview
# Deploying Your Documentation to GitHub
In this lesson, you will learn how to deploy your project documentation to GitHub using MkDocs. 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.
Steps to Deploy Documentation to GitHub
Step 1: Rebuild and Deploy
Running the following command rebuilds the documentation from your Markdown files and source code and pushes it to the gh-pages branch and your remote GitHub repository.
mkdocs gh-deployStep 2: Accessing Documentation
After deployment, your documentation will be available at the URL that MkDocs shows you at the end of your terminal output. You can explore your project documentation online by visiting this URL in your browser.
Step 3: Checking Availability
If you encounter a 404 error when visiting the URL, consider taking a short break. It can take up to ten minutes for your documentation to go live after creating or publishing your GitHub Pages site.
Conclusion
Once deployed, you have a well-structured base for your project documentation. It is partly auto-generated from your docstrings using mkdocstrings and built for front-end consumption with MkDocs. Additionally, it is available online through GitHub Pages.
By following these steps, you can easily deploy your project documentation to GitHub using MkDocs.
Course Contents
This lesson is part of the “Building Python Project Documentation With MkDocs” course. To review other sections of the course, visit the links below:
- Overview
- Project Demo and Details
- Preparing Your Environment
- Creating the Sample Python Package
- Writing and Formatting Your Docstrings
- Preparing, Building, and Deploying Your Documentation
- Building Python Project Documentation With MkDocs (Summary)
By following the entire course, you can gain comprehensive knowledge on building and deploying Python project documentation using MkDocs.
In conclusion, by following the steps outlined in this lesson, you can easily deploy your project documentation to GitHub using MkDocs. Good luck with your project documentation deployment!
