Skip to content

Fix the documentation publishing workflow #150

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

Merged
stefanv merged 1 commit into from
Sep 11, 2026
+3 −25
Merged

Fix the documentation publishing workflow #150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 3 additions & 25 deletions .github/workflows/publish_docs_to_pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:
- main

permissions:
contents: read
contents: write

jobs:
build:
Expand All @@ -15,9 +15,8 @@ jobs:
steps:
- uses: actions/checkout@v5
with:
# The deploy step below checks out gh-pages.
# The deploy step below checks out gh-pages and pushes to it.
fetch-depth: 0
persist-credentials: false
- uses: actions/setup-python@v7
with:
python-version: '3.13'
Expand All @@ -32,32 +31,11 @@ jobs:
mv build/html /tmp
cd ..
- name: Deploy to gh-pages branch
env:
GH_ACTION_PAGES_DEPLOY_KEY: ${{ secrets.GH_ACTION_PAGES_DEPLOY_KEY }}
run: |
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Set up SSH key
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
mkdir -p ~/.ssh/
echo "$GH_ACTION_PAGES_DEPLOY_KEY" > ~/.ssh/id_rsa
chmod 600 ~/.ssh/id_rsa
ssh-keyscan github.com >> ~/.ssh/known_hosts
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Reconfigure the git remote to use SSH
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
git remote rm origin
git remote add origin git@github.com:numpy/numpy-financial.git
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Configure the git user
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
git config user.name "${GITHUB_ACTOR}"
git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
# Go to work on gh-pages...
# - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
echo "Fetching gh-pages"
git fetch origin gh-pages
echo "Checking out gh-pages branch"
git fetch origin gh-pages
git checkout gh-pages
echo "Removing old dev documentation"
git clean -xdf .
Expand Down
Loading