An open API service indexing awesome lists of open source software.

https://github.com/readthedocs/actions

GitHub Actions for Read the Docs
https://github.com/readthedocs/actions

docs documentation read-the-docs

Last synced: 7 months ago
JSON representation

GitHub Actions for Read the Docs

Awesome Lists containing this project

README

          

# GitHub Actions for Read the Docs

> [!WARNING]
> **This action is deprecated and it shouldn't be used.**
> This feature was included in the Read the Docs application itself.
> For more information, check [our documentation](https://docs.readthedocs.com/platform/stable/visual-diff.html#show-build-overview-in-pull-requests).

This repository contains all the official GitHub Actions for Read the Docs.

## Release and tags

We follow the conventions defined by GitHub at
[Using release management for actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions#using-release-management-for-actions)

We recommend you to pin to the latest stable version, `v1`, as follows:

```yaml
- uses: readthedocs/actions/preview@v1
```

## List of actions

1. [readthedocs/actions/preview](https://github.com/readthedocs/actions/tree/v1/preview): Add Read the Docs preview's link to Pull Requests

## License![MIT licensed](https://img.shields.io/github/license/readthedocs/actions)

All the actions in this repository are published with the [MIT](./LICENSE) license.