Skip to content

Commit f66a5a8

Browse files
authored
Merge pull request #208 from Langhaarzombie/master
- Fixes the Gem warning on page build (already reviewed) - Fixes the default layout of pages, 404 page looks good (already reviewed) - Adds message to dowloads page that it is archived - Reads the documentation page to the navbar for older versions - Fixes a href for the supporting organisations which is sometimes used on external pages
2 parents 942a468 + b1becdc commit f66a5a8

File tree

9 files changed

+71
-20
lines changed

9 files changed

+71
-20
lines changed

.github/workflows/jekyll.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Deploy Website using Jekyll
2+
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: "pages"
15+
cancel-in-progress: false
16+
17+
jobs:
18+
# Build job
19+
build:
20+
runs-on: ubuntu-22.04
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
- name: Setup Ruby
25+
uses: ruby/setup-ruby@v1
26+
with:
27+
ruby-version: '3.1'
28+
bundler-cache: true
29+
- name: Setup Pages
30+
id: pages
31+
uses: actions/configure-pages@v5
32+
- name: Build with Jekyll
33+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
34+
env:
35+
JEKYLL_ENV: production
36+
- name: Upload artifact
37+
uses: actions/upload-pages-artifact@v3
38+
39+
# Deployment job
40+
deploy:
41+
if: ${{ github.repository == 'qutip/qutip.github.io' && github.ref == 'refs/heads/master' }}
42+
environment:
43+
name: github-pages
44+
url: ${{ steps.deployment.outputs.page_url }}
45+
runs-on: ubuntu-latest
46+
needs: build
47+
steps:
48+
- name: Deploy to GitHub Pages
49+
id: deployment
50+
uses: actions/deploy-pages@v4

Gemfile

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
source "https://rubygems.org"
22

3-
gem "github-pages", "~> 231", group: :jekyll_plugins
4-
gem "webrick", "~> 1.8"
5-
gem "csv", "~> 3.3"
3+
gem "jekyll", "~> 4.4"

_config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
title: QuTiP - Quantum Toolbox in Python
2+
defaults:
3+
-
4+
scope:
5+
path: ""
6+
values:
7+
layout: default
28
exclude:
39
- "build-scripts/"
410
- "CNAME"

_includes/navbar.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@
6262
<li><h6 class="dropdown-header">Previous Versions</h6></li>
6363
<li><a class="dropdown-item" href="https://qutip.readthedocs.io/en/qutip-4.7.x/">QuTiP 4.7.x</a></li>
6464
<li><a class="dropdown-item" href="https://colab.research.google.com/drive/18TcuHNQifYSHdGey7otK8IPDB1YbDZpW?usp=sharing">Migrate to QuTiP v5</a></li>
65+
<li><a class="dropdown-item" href="/documentation">All Versions</a></li>
6566
</ul>
6667
</li>
6768
<li class="nav-item dropdown-center">

_includes/supp_org.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div class="container-xxl my-center-section">
1+
<div id="supporting-organizations" class="container-xxl my-center-section">
22
<h2>Supporting Organisations</h2>
33
<p>
44
Developers from <a href="https://dml.riken.jp/" target="about:blank">Nori's Lab</a>,

devs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
22
title: QuTiP Contributors
3-
layout: default
43
---
54

65
# QuTiP Contributors

documentation.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ title: QuTiP Documentation
44

55
# Users guide
66

7+
Here you can find direct links to all our documentation for new and old versions of QuTiP.
8+
If you are interested in contributing to QuTiP, check out the <a href="https://qutip.readthedocs.io/en/stable/development/contributing.html">contribution section in our documentation</a>.
9+
710
## Latest releases
811

912
### Version 5.2.0
@@ -201,8 +204,3 @@ title: QuTiP Documentation
201204
<a onclick="javascript:_gaq.push(['_trackEvent','download','qutip-doc','qutip-2.2.0-DOC.pdf']); void(0);" href="downloads/2.2.0/QuTiP-2.2.0-DOC.pdf">PDF documentation</a>
202205
</div>
203206
</div>
204-
205-
206-
## Development documentation
207-
208-
The documentation for the development version of QuTiP is available at the <a href="https://github.com/qutip/qutip-doc">qutip-doc</a> github repository.

download.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
title: QuTiP Features
2+
title: QuTiP Releases
33
---
44

5-
<div class="row">
6-
<div class="col-md-12">
7-
<div class="alert alert-danger">
8-
QuTiP has been developed over seven years by volunteers working in their spare time. If you find QuTiP useful, please consider taking a minute of your own time and <a href='citing.html'>citing it</a> in your publications.
9-
</div>
10-
</div>
11-
</div>
12-
135
# Download
146

157
The recommended way to install QuTiP is with conda or pip, see the
168
[documentation](https://qutip.org/docs/latest/installation.html) for details.
179

10+
<div class="row">
11+
<div class="col-md-12">
12+
<div class="banner" style="margin-top: 0;">
13+
<p id="cite">This page has been archived! For the latest updates please refer to the release info on our <a href="https://github.com/qutip/qutip/releases">GitHub Page</a></p>.
14+
</div>
15+
</div>
16+
</div>
17+
1818
## Latest releases
1919

2020
### Version 5.2.0 - 6 June 2025

news.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
layout: default
32
title: QuTiP News
43
---
54

0 commit comments

Comments
 (0)