Get URL of staging document, when you review changes.
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, or
- sharing screenshot to share the updated document like this.
This bot automates the first approach; activate RTD build automatically when you made PR that updates
To install rtd-bot to your GitHub repository, follow these interactions:
- Make sure that your RTD project has been connected with GitHub repository, or integrated via GitHub webhook.
rtd-botuser to your RTD project as maintainer.
.github/config.ymlfile in your repo.
- Enable rtd-bot in your repo from the rtd-bot page at GitHub.
Here is a sample
rtd: project: your-read-the-docs-project
Configuration for the project with translations
If you use translations feature, make sure you've configured all your RTD projects including translations.
.github/config.yml file, set the project slug of the root RTD project.
In Read the Docs, inviting maintainer means you give admin access to target account.
So if you do not want to invite
rtd-bot as maintainer, you can host this Probot app by own.
To host this bot by own, you need to set following environment variables:
RTD_USERNAMEthat is same with user name of Read the Docs
RTD_PASSWORDthat is same with password of Read the Docs
APP_IDthat is described at Probot document.
- One of
PRIVATE_KEYthat is described at Probot document.
To run this bot on Heroku, you need to add a buildpack. See puppeteer document for detail.
Copyright 2018 Kengo TODA
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.