Which site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign upWhich site best fits your project?
Free for open-source software.
Sign upPlans starting at $50/month.
Sign up
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.
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.
.readthedocs.yaml
# Example for a Node-based doc tool (e.g. Docusaurus).
# Replace the install/build commands with whatever your tool uses
# (mkdocs build, sphinx-build, jupyter-book build, etc).
version: 2
build:
os: ubuntu-24.04
tools:
nodejs: "20"
commands:
# Install dependencies and build the site
- cd docs/ && npm install
- cd docs/ && npm run build
# Copy output to Read the Docs
- mkdir -p $READTHEDOCS_OUTPUT/html/
- cp -r docs/build/* $READTHEDOCS_OUTPUT/html/
Get started with any documentation tool today.