-
Notifications
You must be signed in to change notification settings - Fork 5
Add the readthedocs preview back #154
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
Open
m-aciek
wants to merge
9
commits into
main
Choose a base branch
from
add-readthedocs-preview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
567ee49
Create .readthedocs.yml
rffontenelle 325faab
Create documentation-links.yml
rffontenelle deaa9b3
Rename .readthedocs.yml to .readthedocs.yaml
rffontenelle d0d4c1c
Update .readthedocs.yaml: moving build directory
m-aciek 961c7cd
Revert "Create documentation-links.yml"
m-aciek 90ad988
Install requirements
m-aciek 442383e
Run second generation script
m-aciek 29616ff
Simplify readthedocs script
m-aciek 4263c4e
Revert "Run second generation script"
m-aciek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,24 @@ | ||
| name: Read the Docs PR preview | ||
| # Automatically edits a pull request's descriptions with a link | ||
| # to the documentation's preview on Read the Docs. | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: | ||
| - opened | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| documentation-links: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: readthedocs/actions/preview@v1 | ||
| with: | ||
| project-slug: "pydocs-translation-dashboard" | ||
| single-version: "true" | ||
This file contains hidden or 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,17 @@ | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
| # Project page: https://app.readthedocs.org/projects/pydocs-translation-dashboard/ | ||
|
|
||
| version: 2 | ||
|
|
||
| build: | ||
| os: ubuntu-24.04 | ||
| tools: | ||
| python: "3" | ||
| commands: | ||
| - asdf plugin add uv | ||
| - asdf install uv latest | ||
| - asdf global uv latest | ||
| - uv run generate.py | ||
| - mkdir -p _readthedocs/html | ||
| - mv index.html style.css _readthedocs/html | ||
m-aciek marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This action is deprecated.
We could replace this workflow with the new app?
See python/core-workflow#587 for details.