Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rtd-bot to the list #243

Merged
merged 6 commits into from
Jan 7, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions _apps/rtd-helper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
# A human-friendly name of your listing
title: Read The Docs Helper
# A short description of what your app does
description: Assists reviewing using Read The Docs (RTD)
# The slug of your hosted app on GitHub (https://github.com/apps/YOUR-SLUG)
slug: rtd-helper
# Include a few screenshots that show your app in action
screenshots:
- https://raw.githubusercontent.com/KengoTODA/rtd-bot/master/screenshot.png
# The GitHub usernames of anyone who authored the app
authors:
- KengoTODA
# The repository where the code is located
repository: KengoTODA/rtd-bot
# The address where this app is deployed
host: https://rtd-bot.herokuapp.com
---

Get URL of documents when review changes in docs directory.

Work with Read The Docs, then you'll find that PR for documentation needs additional steps like:

* running RTD build for your branch manually, to use its result as staging site [like this](https://github.com/spotbugs/spotbugs/pull/697#issue-201455071), or
* sharing screenshot to share the updated document [like this](https://github.com/spotbugs/spotbugs/pull/718#issue-205904835).

This bot automates the first approach; activate RTD build automatically when you made PR that updates `docs/` directory.