Mike

Overview

Mike is a powerful Python utility designed to simplify the deployment of multiple versions of documentation generated with MkDocs to a Git branch, making it perfect for hosting on GitHub via gh-pages. With its intuitive approach, mike ensures that once your documentation for a specific version is generated, there’s no need to revisit it, thus safeguarding against potential breaking changes in MkDocs. This means your historical documentation remains intact and accessible, allowing users to always find the right resources.

With its flexible configuration options, mike excels at organizing documentation in a structured manner with major and minor version directories and the ability to create aliases for notable versions. This ensures that users can easily navigate to and share the documentation version that matters most to them, enhancing the overall accessibility of your technical resources.

Features

• Version Control: Each deployment creates a new Git commit on your gh-pages branch, ensuring that your documentation is always in sync with the code's versions.
• Ease of Use: The command mike deploy takes care of overwriting existing docs for the deployed version while leaving other versions untouched, simplifying version management.
• MkDocs Integration: Automatically includes an MkDocs plugin during the documentation build process, allowing for a seamless setup.
• Custom Aliases: Supports creating aliases for specific versions (e.g., latest or dev), enabling easy access for your users and removable permalinks.
• Shell Completion: Installation can integrate with shell-completion tools like shtab, making command usage more efficient.
• Flexible Deployment Directory: Allows configuration of a root directory for generated docs, accommodating additional pages or multiple independently-versioned sets of documentation.
• Rollback Support: Users can delete old documentation or move it to a subdirectory, keeping past versions accessible while maintaining a clean deployment.