Read the Docs Addons
Read the Docs Addons is a group of features for documentation readers and maintainers that you can add to any documentation set hosted on Read the Docs:
- DocDiff
highlight changed output from pull requests
- Pull request notification
notify readers that they are reading docs from a pull request
- Flyout
easily switch between versions and translations
- Non-stable notification
notify readers that they are reading docs from a non stable release
- Latest version notification
notify readers that they are reading docs from a development version
- Search as you type
get search results faster
Enabling Read the Docs Addons
All projects using mkdocs mkdocs or the build.command build command are already using the Addons, other projects can enable them by following these steps:
Go to the new dashboard:
Click on a project name.
Go to Settings, then in the left bar, go to Addons.
Check Enable Addons, and then configure each Addon individually.
Note
Read the Docs Addons will be enabled by default for all Read the Docs projects on October 7th. Read the full announcement in our blog post.
Configuring Read the Docs Addons
Individual configuration options for each addon are available in Settings.
Go to the new dashboard:
Click on a project name.
Go to Settings, then in the left bar, go to Addons.
Configure each Addon individually.