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
- Host: GitHub
- URL: https://github.com/readthedocs/actions
- Owner: readthedocs
- License: mit
- Created: 2022-07-25T09:46:15.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T16:33:23.000Z (over 1 year ago)
- Last Synced: 2025-04-19T08:35:20.139Z (about 1 year ago)
- Topics: docs, documentation, read-the-docs
- Language: JavaScript
- Homepage:
- Size: 75.2 KB
- Stars: 36
- Watchers: 5
- Forks: 12
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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
All the actions in this repository are published with the [MIT](./LICENSE) license.