Skip to content

Commit

Permalink
add rtd setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jsstevenson committed Feb 3, 2024
1 parent 44684ca commit 2f06ed8
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions readthedocs_setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# readthedocs setup notes

* Settings
* Programming Language: `Python`
* Advanced Settings
* Default version: `Stable` (ideally)
* Versioning scheme: `Multiple versions without translation`
* Build pull requests for this project
* Integrations
* GitHub Incoming Webhook
* Environment variables
* `SPHINX_GITHUB_CHANGELOG_TOKEN`: provide a read-only fine-grained github token (https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#fine-grained-personal-access-tokens). I have an active one. It'll require renewal at least every 12 months.
* Automation rules
* Stable release rule
* Match: `Custom match`
* Custom match: a pattern for latest stable release
* Version type: `Tag`
* Action: `Set version as default`
* Dev version release rule
* Match: `Custom match`
* Custom match: a pattern for a dev release
* Version type: `Tag`
* Action: `Activate version`

0 comments on commit 2f06ed8

Please sign in to comment.