Host any documentation tool

Examples of Read the Docs hosted documentation

Read the Docs supports any documentation tool by allowing full control of the build commands your project runs. Enjoy powerful features such as search-as-you-type, previews from Git, and much more.

Create an account Learn more

Receive feedback from your team, and have confidence in changes before they go live.

Search across all your projects with our search-as-you-type interface, and never lose documentation again.

Customize the build commands to suit your project’s needs. Flexibility to support any tool.

Try it out

.readthedocs.yaml

# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
  os: ubuntu-24.04
  tools:
    python: "3.12"
    nodejs: "20"
    # You can also specify other tool versions:
    # rust: "1.70"
    # golang: "1.20"

  # Support any tool with custom build commands
  commands:
    # Install dependencies
    - cd docs/ && npm install
    # Build the site
    - cd docs/ && npm run build
    # Copy generated files into Read the Docs directory
    - mkdir --parents $READTHEDOCS_OUTPUT/html/
    - cp --recursive docs/build/* $READTHEDOCS_OUTPUT/html/

Get started with any documentation tool today.

Create an account

Deploy with any tool

Collaborate with deploy previews

Always find what you need

Full customization of build commands

Upgrade your documentation with Read the Docs