Updating the site_url (if you set it) to point to the version of the docs thatĪre being built: plugins : - mike : # these fields are all optional the defaults are as below. The plugin adds a version selector to supported themes as well as This plugin is added by default when building yourĭocumentation with mike, but by adding it explicitly, you can configure how it For more details on how to set this up, consult shtab'sīefore using mike for the first time, you may want to add the mike plugin Mike generate-completion, which will print the shell-completion code for your If you have shtab installed, you can do this with Once you've installed mike, you might also want to set up shell-completion for Is what you might expect: pip install mike Like most Python projects, mike uses setuptools, so installation Previously-deployed docs for that version are erased and overwritten, but docsįor other versions remain untouched.

Mike works by creating a new Git commit on your gh-pages branch every time youĭeploy a new version of your docs using mike deploy (or other mike subcommands Version of the documentation you want to direct people to. While mike is flexible, it's optimized around putting your docs in a Means you never have to worry about breaking changes in MkDocs, since your oldĭocs (built with an old version of MkDocs) are already generated and sitting in Particular version, you should never need to touch that version again. Mike is built around the idea that once you've generated your docs for a

To see an example of this in action, take a MkDocs-powered docs to a Git branch, suitable forĭeploying to Github via gh-pages. Mike is a Python utility to easily deploy multiple versions of your

Mike 21 python