Using Read the Docs daily

Read the Docs helps you with building, reviewing and publishing documentation for your customers by following the docs as code pattern that you may be already using. Allow your readers to browse different versions of your documentation, switch between langauges and perform searches accross all your projects. They will appreciate you are using Read the Docs for your documentation.

Write documentation using a rich ecosystem of tools and markups.

Preview each change before publishing.

Automatically deploy the documentation on merge.

Expose different versions of your documentation to readers.

Read the Docs is the all-in-one solution for docs as code.

Write documentation using your favourite editor and tool. Read the Docs doesn’t force you to use any one in particular. No WebUI, or WYSIWYG editor. No lock-in. You can use the one you already love.

Documentation

Once you are done writing the documentation, push you changes to Git and open a pull request to collaborate with your team. Accept or reject suggestions from your co-workers while previewing the live changes on Read the Docs.

Documentation

When you open the pull request, you and your team can see the live changes on Read the Docs to evaluate the content, but also looking for style and look & feel issues, that are impossible to find out from the diff code in the pull request.

Documentation

After getting an approval in your pull request from your team and merging it, Read the Docs will build and deploy those changes to production automatically.

Documentation

Try it out

.readthedocs.yaml

version: 2
build:
  os: ubuntu-24.04
  tools:
    python: "3.12"
    # You can also specify other tool versions:
    # nodejs: "20"

# Build documentation in the docs/ directory with Sphinx
sphinx:
   configuration: docs/conf.py

# Dependencies required to build your docs
python:
   install:
   - requirements: docs/requirements.txt

Simplify you day to day work by writing, building, previewing and publishing your documentation with Read the Docs. Collaborate with all your team in an easy way that everybody understands and can immediately see the changes after pushing them to Git.

Read the Docs in your daily work

Write the documentation

Push the changes to Git

Preview your pull request

Deploy with one click

Upgrade your documentation with Read the Docs

Save time and headaches!