Deploying your docs
A basic guide to deploying your docs to various hosting providers
If you host the source code for a project on GitHub, you can easily use
GitHub Pages to host the documentation for your project. After you
the primary working branch (usually
master) of the git repository where you
maintain the source documentation for your project, run the following command:
That's it! Behind the scenes, MkDocs will build your docs and use the ghp-import tool to commit them to the gh-pages branch and push the gh-pages branch to GitHub.
mkdocs gh-deploy --help to get a full list of options available for the
Be aware that you will not be able to review the built site before it is pushed
to GitHub. Therefore, you may want to verify any changes you make to the docs
beforehand by using the
serve commands and reviewing the built
You should never edit files in your gh-pages branch by hand if you're using
gh-deploy command because you will lose your work.
Read the Docs
Read the Docs offers free documentation hosting. You can import your docs using any major version control system, including Mercurial, Git, Subversion, and Bazaar. Read the Docs supports MkDocs out-of-the-box. Follow the instructions on their site to arrange the files in your repository properly, create an account and point it at your publicly hosted repository. If properly configured, your documentation will update each time you push commits to your public repository.
To benefit from all of the features offered by Read the Docs, you will need to use the Read the Docs theme which ships with MkDocs. The various themes which may be referenced in Read the Docs' documentation are Sphinx specific themes and will not work with MkDocs.
If you maintain a Python project which is hosted on the Python Package Index (PyPI), you can use the hosting provided at pythonhosted.org to host documentation for your project. Run the following commands from your project's root directory to upload your documentation:
mkdocs build python setup.py upload_docs --upload-dir=site
Your documentation will be hosted at
<projectname> is the name you used to register your project with PyPI.
There are a few prerequisites for the above to work:
- You must be using Setuptools in your
setup.pyscript (Distutils does not offer an
- Your project must already be registered with PyPI (use
python setup.py register).
mkdocs.ymlconfig file and your "docs" directory (value assigned to the docs_dir configuration option) are presumed to be in the root directory of your project alongside your
- It is assumed that the default value (
"site") is assigned to the site_dir configuration option in your
mkdocs.yamlconfig file. If you have set a different value, assign that value to the
Any hosting provider which can serve static files can be used to serve documentation generated by MkDocs. While it would be impossible to document how to upload the docs to every hosting provider out there, the following guidelines should provide some general assistance.
When you build your site (using the
mkdocs build command), all of the files
are written to the directory assigned to the site_dir configuration option
"site") in your
mkdocs.yaml config file. Generally, you will
simply need to copy the contents of that directory to the root directory of your
hosting provider's server. Depending on your hosting provider's setup, you may
need to use a graphical or command line ftp, ssh or scp client to transfer
For example, a typical set of commands from the command line might look something like this:
mkdocs build scp -r ./site user@host:/path/to/server/root
Of course, you will need to replace
user with the username you have with your
hosting provider and
host with the appropriate domain name. Additionally, you
will need to adjust the
/path/to/server/root to match the configuration of
your hosts' file system.
See your host's documentation for specifics. You will likely want to search their documentation for "ftp" or "uploading site".
When MkDocs builds the documentation it will include a 404.html file in the build directory. This file will be automatically used when deploying to GitHub but only on a custom domain. Other web servers may be configured to use it but the feature won't always be available. See the documentation for your server of choice for more information.