Skip to content
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

Jump to bottom

20241118 docs update beta #107

Merged
merged 7 commits into from
Nov 19, 2024
Merged

20241118 docs update beta #107

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b7c4dc3
(workflow): update docs for beta & stable
benjaminbollen Nov 18, 2024
5fb3ce4
(workflow): temporarily add doc building to testdocs branch
benjaminbollen Nov 18, 2024
3de2f55
(workflow): oops, missed an s
benjaminbollen Nov 18, 2024
e4ae1f0
(workflow): instead build beta and stable docs on any trigger
benjaminbollen Nov 18, 2024
60400e1
(workflow): pull branches, drop conda for just pip, improve html
benjaminbollen Nov 18, 2024
602e16e
(workflow): learnt I can just push to testdocs; but now it works
benjaminbollen Nov 18, 2024
2d39f60
(workflow): ensure naming Candidate Stable
benjaminbollen Nov 18, 2024
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
92 changes: 74 additions & 18 deletions .github/workflows/deploy-mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,94 @@ name: Deploy MkDocs to GitHub Pages
on:
push:
branches:
- v0.3.6-docs
- beta
- candidate/stable
- 20241118-docs-update-beta

permissions:
contents: write
pages: write
id-token: write

jobs:
deploy:
permissions:
contents: write # This allows writing to the repository contents
pages: write # This allows deploying to GitHub Pages
id-token: write # This is required for requesting the JWT
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: Set up Conda
uses: conda-incubator/setup-miniconda@v2
- uses: actions/checkout@v4
with:
auto-update-conda: true
python-version: 3.9

fetch-depth: 1

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.9'
cache: 'pip'

- name: Install dependencies
shell: bash -l {0}
run: |
cd docs/
conda install -c conda-forge --file requirements.txt

- name: Build site
shell: bash -l {0}
pip install -r requirements.txt

- name: Build Beta Documentation
run: |
git fetch --depth 1 origin beta:beta
git checkout beta
cd docs/
mkdocs build
mkdir -p ../gh-pages/beta
cp -R site/* ../gh-pages/beta/

- name: Build Candidate Stable Documentation
run: |
git fetch --depth 1 origin candidate/stable:candidate/stable
git checkout candidate/stable
cd docs/
mkdocs build
mkdir -p ../gh-pages/candidate-stable
cp -R site/* ../gh-pages/candidate-stable/

- name: Create Redirect Index
run: |
cat > ./gh-pages/index.html << 'EOF'
<!DOCTYPE html>
<html>
<head>
<title>Documentation Redirect</title>
<meta http-equiv="refresh" content="0; url=beta/">
<style>
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
max-width: 600px;
margin: 50px auto;
text-align: center;
line-height: 1.6;
}
.links {
margin-top: 20px;
}
a {
color: #0366d6;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
</style>
</head>
<body>
<h1>Documentation</h1>
<p>Redirecting to the latest beta documentation...</p>
<div class="links">
<p>If you are not redirected, please choose a version:</p>
<p><a href="beta/">Beta Documentation</a> | <a href="candidate-stable/">Candidate Stable Documentation</a></p>
</div>
</body>
</html>
EOF

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/site
publish_dir: ./gh-pages
force_orphan: true
Loading