How-to guides: content, themes and SEO

⏩️ Search engine optimization (SEO) for documentation projects

This article explains how documentation can be optimized to appear in search results, ultimately increasing traffic to your docs.

⏩️ Enabling canonical URLs

In this guide, we introduce relevant settings for enabling canonical URLs in popular documentation frameworks.

⏩️ Using traffic analytics

In this guide, you can learn to use Read the Docs’ built-in traffic analytics for your documentation project. You will also learn how to optionally add your own Google Analytics account or completely disable Google Analytics on your project.

⏩️ Managing translations for Sphinx projects

This guide walks through the process needed to manage translations of your documentation. Once this work is done, you can setup your project under Read the Docs to build each language of your documentation by reading Localization and Internationalization.

⏩️ Supporting Unicode in Sphinx PDFs

Sphinx offers different LaTeX engines that have better support for Unicode characters, relevant for instance for Japanese or Chinese.

⏩️ Cross-referencing with Sphinx

When writing documentation you often need to link to other pages of your documentation, other sections of the current page, or sections from other pages.

⏩️ Linking to other projects with Intersphinx

This section shows you how to maintain references to named sections of other external Sphinx projects.

⏩️ Using Jupyter notebooks in Sphinx

There are a few extensions that allow integrating Jupyter and Sphinx, and this document will explain how to achieve some of the most commonly requested features.

⏩️ Migrating from rST to MyST

In this guide, you will find how you can start writing Markdown in your existing reStructuredText project, or migrate it completely.

⏩️ Enabling offline formats

This guide provides step-by-step instructions to enabling offline formats of your documentation.

⏩️ Using search analytics

In this guide, you can learn to use Read the Docs’ built-in search analytics for your documentation project.

⏩️ Adding custom CSS or JavaScript to Sphinx documentation

Adding additional CSS or JavaScript files to your Sphinx documentation can let you customize the look and feel of your docs or add additional functionality.

⏩️ Embedding content from your documentation

Did you know that Read the Docs has a public API that you can use to embed documentation content? There are a number of use cases for embedding content, so we’ve built our integration in a way that enables users to build on top of it.

⏩️ Removing “Edit on …” buttons from documentation

When building your documentation, Read the Docs automatically adds buttons at the top of your documentation and in the versions menu that point readers to your repository to make changes. Here’s how to remove it.

⏩️ Adding “Edit Source” links on your Sphinx theme

Using your own theme? Read the Docs injects some extra variables in the Sphinx html_context, some of which you can use to add an “edit source” link at the top of all pages.