How does it work?¶

To use the new beta feature, you can specify all the commands the build process requires under the build.commands config key. Finally, move the resulting documentation artifacts into the _readthedocs/html directory. Read the Docs will upload and host all the content of that folder ✨

Here is simple example that builds the Docusaurus tutorial:

version: 2

build:
  os: ubuntu-22.04
  tools:
    nodejs: "18"
  commands:
    # "docs/" directory was created using the command to create the site:
    # npx create-docusaurus@latest docs classic
    #
    # Install Docusaurus dependencies
    - cd docs/ && npm install
    # Build the site
    - cd docs/ && npm run build
    # Copy generated files into Read the Docs directory
    - mkdir --parents _readthedocs/html/
    - cp --recursive docs/build/* _readthedocs/html/

The resulting documentation lives at https://test-builds.readthedocs.io/en/docusaurus/.

If you want to read more about build.commands, read the full documentation.

Limitations¶

This feature is still in beta and has some limitation currently. We are working to make build.commands more integrated into our platform. One major missing feature is the flyout, which gives access to downloads, versions and other functionality. We are actively working on improving this feature, and we will publishing more content about this in the next months. Stay tuned!

Try it out and give us feedback!¶

We want to continue improving this beta feature. It has lot of potential and we want to develop it in a way that’s useful for our users. Please, give it a try and let us know how are you using it and if it’s missing something for your use case.