Skip to content

POC + WIP CI: Deploy pre-built docs directly to ReadTheDocs for PR preview #4903

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.

Sign up for GitHub

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

Draft
seisman wants to merge 3 commits into
base: main
Choose a base branch
from
+9 −1
Draft

POC + WIP CI: Deploy pre-built docs directly to ReadTheDocs for PR preview #4903

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5ffdcad
CI: Deploy pre-built docs directly to ReadTheDocs for PR preview
seisman Sep 20, 2026
66450e2
Fix step name [skip ci]
seisman Sep 20, 2026
7cfe24e
Merge branch 'main' into ci/rtd
seisman Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion .github/workflows/ci_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,15 @@ jobs:
mv latex/pygmt.pdf pygmt-docs.pdf
cd ../..

- name: Upload PDF as artifact for previewing on pull requests
- name: Upload the documentation to ReadTheDocs for PR preview
uses: readthedocs/upload-action@f1f5bac5fc97073927100367d8a5bb22587e1e16 # main
if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository && matrix.os == 'ubuntu-latest'
with:
token: ${{ secrets.READTHEDOCS_TOKEN }}
project-slug: pygmt-dev
html: doc/_build/html

- name: Upload PDF as artifact for PR preview
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
if: github.event_name == 'pull_request' && matrix.os == 'ubuntu-latest'
with:
Expand Down
Loading