Hosting

Once you have created your documentation either in Sphinx, Jupyter Book, MkDocs or Quarto, you can host it online.

GitHub Pages

GitHub Pages provides a simple way to host your documentation, especially if your project is already on GitHub.

It is straightforward to set up GitHub Pages:

1. Within your repository, go to the repository settings and find the GitHub Pages section.
2. Choose your publishing source (you should have a docs folder or a dedicated branch).

GitHub Pages also supports custom domains, which might be relevant to you. You can configure this by adding a CNAME file to your directory.

Learn more

• GitHub Pages
• Configuring a custom domain for your GitHub Pages site
• Coderefinery - Deploying Sphinx documentation to GitHub Pages
• Coderefinery - Hosting websites/homepages on GitHub Pages

Read the Docs

Read the Docs is a platform that simplifies the hosting of documentation. It integrates particularly well with Sphinx, allowing for the automatic building and hosting of your project documentation. Read the Docs supports automatic builds and version control, enabling users to switch between different versions of the documentation to match the version of the software they are using. Additionally, it offers support for custom domains.

It offers a free service for open-source projects, which includes features like version control and automatic builds. However, for private or commercial projects, Read the Docs requires a paid subscription.

The setup is also straightforward:

1. Sign up and import your documentation repository.
2. Connect to your GitHub account.
3. Configure your project settings within their dashboard.

Learn more

• Read the Docs: documentation simplified
• Read the Docs tutorial