-
Notifications
You must be signed in to change notification settings - Fork 155
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |