StackStorm / st2docs

StackStorm Documentation.
https://docs.stackstorm.com/
64 stars 170 forks source link

Add support for building docs on ReadTheDocs (esp for PRs) #1157

Closed cognifloyd closed 1 year ago

cognifloyd commented 1 year ago

This adds the .readthedocs.yaml config file that RTD needs to be able to build our docs.

Once this is in, RTD will build PRs for us. For example, this PR was built on RTD. To see it, under checks, click on the docs/readthedocs.org:st2docs details link, and then click the little View docs link on the right hand side under the build statistics (not the big "View Docs" button at the top, look farther down the page).

There are no current plans to switch docs.stackstorm.com over to RTD.