Skip to content

Commit

Permalink
🤖 Add rtd-bot (#243)
Browse files Browse the repository at this point in the history
  • Loading branch information
KengoTODA authored and gr2m committed Jan 7, 2020
1 parent ce2314f commit 06ebf54
Showing 1 changed file with 27 additions and 0 deletions.
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.

0 comments on commit 06ebf54

Please sign in to comment.