Skip to content

Latest commit

 

History

History
53 lines (35 loc) · 1.84 KB

addons.rst

File metadata and controls

53 lines (35 loc) · 1.84 KB

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:

:doc:`Traffic analytics </analytics>`
explore pageviews for your docs
:doc:`DocDiff </pull-requests>`
highlight changed output from pull requests
:doc:`Pull request notification </pull-requests>`
notify readers that they are reading docs from a pull request
:doc:`Flyout </flyout-menu>`
easily switch between versions and translations
:doc:`Non-stable notification </notifications>`
notify readers that they are reading docs from a non stable release
:doc:`Latest version notification </notifications>`
notify readers that they are reading docs from an older version
:doc:`Search as you type </server-side-search/index>`
get search results faster

Enabling Read the Docs Addons

All projects using the build.command :ref:`build command <config-file/v2:build.commands>` are already using the Addons, other projects can enable them by following these steps:

  1. Go to the new dashboard:

  2. Click on a project name.

  3. Go to :guilabel:`Settings`, then in the left bar, go to :guilabel:`Addons (Beta)`.

  4. Check :guilabel:`Enable Addons`, and then configure each Addon individually.

Configuring Read the Docs Addons

Individual configuration options for each addon are available in :guilabel:`Settings`.

  1. Go to the new dashboard:

  2. Click on a project name.

  3. Go to :guilabel:`Settings`, then in the left bar, go to :guilabel:`Addons (Beta)`.

  4. Configure each Addon individually.