-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from albinahlback/overhaul
Clean up FLINT webpage and automate deployment
- Loading branch information
Showing
55 changed files
with
1,716 additions
and
81 deletions.
There are no files selected for viewing
This file contains 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,25 @@ | ||
# Workflow to deploy to website | ||
|
||
name: Deploy | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
deploy: | ||
name: Push documentation to website | ||
if: github.repository == 'flintlib/flintwebpage' | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: "Setup SSH key" | ||
uses: shimataro/ssh-key-action@v2.7.0 | ||
with: | ||
key: ${{ secrets.SSH_KEY }} | ||
name: id_ed25519 | ||
known_hosts: ${{ secrets.KNOWN_HOSTS }} | ||
|
||
- name: "Deploy" | ||
run: | | ||
ssh -t wbhart@opal6.opalstack.com 'cd ~/flintwebpage && git checkout master && git pull && python3 downloads.py ~/apps/flintlib_org && python3 build.py ~/apps/flintlib_org && cp -r img/ ~/apps/flintlib_org' |
This file contains 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 |
---|---|---|
@@ -1,3 +1,2 @@ | ||
people/*.jpg | ||
*.html | ||
temp/* | ||
AUTHORS | ||
src/downloads.txt |
This file contains 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,71 @@ | ||
1.0.0 2007-12-02 | ||
1.0.1 2007-12-07 | ||
1.0.2 2007-12-10 | ||
1.0.3 2007-12-16 | ||
1.0.4 2008-01-04 | ||
1.0.5 2008-01-05 | ||
1.0.6 2008-01-17 | ||
1.0.7 2008-01-22 | ||
1.0.8 2008-02-15 | ||
1.0.9 2008-03-11 | ||
1.0.10 2008-06-16 | ||
1.0.11 2008-07-09 | ||
1.0.12 2008-07-11 | ||
1.0.13 2008-07-13 | ||
1.0.14 2008-09-23 | ||
1.0.15 2008-10-15 | ||
1.0.16 2008-10-22 | ||
1.0.17 2008-11-30 | ||
1.0.18 2008-12-05 | ||
1.0.19 2008-12-12 | ||
1.0.20 2008-12-13 | ||
1.0.21 2008-12-25 | ||
1.1.0 2008-12-21 | ||
1.1.1 2009-02-11 | ||
1.1.2 2009-03-09 | ||
1.1.3 2008-03-09 | ||
1.2.0 2009-03-10 | ||
1.2.1 2009-03-14 | ||
1.2.2 2009-03-20 | ||
1.2.3 2009-03-31 | ||
1.2.4 2009-04-04 | ||
1.2.5 2009-04-18 | ||
1.3.0 2009-06-09 | ||
1.4.0 2009-07-06 | ||
1.5.0 2009-09-22 | ||
1.5.1 XXXX-XX-XX | ||
1.5.2 2010-04-08 | ||
1.6.0 2010-12-24 | ||
2.0.0 2011-01-16 | ||
2.1.0 2011-03-09 | ||
2.2.0 2011-06-04 | ||
2.3.0 2012-11-09 | ||
2.4.0 2013-11-19 | ||
2.4.1 2013-11-20 | ||
2.4.2 2014-03-11 | ||
2.4.3 2014-04-01 | ||
2.4.4 2014-07-17 | ||
2.4.5 2015-02-17 | ||
2.5.0 2015-08-03 | ||
2.5.1 2015-08-05 | ||
2.5.2 2015-08-07 | ||
2.6.0 2020-06-05 | ||
2.6.1 2020-07-23 | ||
2.6.2 2020-07-31 | ||
2.6.3 2020-08-12 | ||
2.7.0 2020-12-18 | ||
2.7.1 2021-01-18 | ||
2.8.0 2021-07-22 | ||
2.8.1 2021-10-01 | ||
2.8.2 2021-10-15 | ||
2.8.3 2021-11-03 | ||
2.8.4 2021-11-17 | ||
2.8.5 2022-04-25 | ||
2.9.0 2022-06-24 | ||
3.0.0 2023-10-20 | ||
3.0.1 2023-11-10 | ||
3.1.0 2024-02-27 | ||
3.1.1 2024-03-07 | ||
3.1.2 2024-03-18 | ||
3.1.3 2024-04-25 | ||
3.1.3-p1 2024-05-24 |
This file contains 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,36 @@ | ||
# Build system | ||
|
||
We generate `src/downloads.txt` that is being used to generate | ||
`${DEST}/downloads.html`. To generate the source file, run | ||
``` | ||
$ python3 downloads.py ${PATH_TO_DEST} | ||
``` | ||
where `${PATH_TO_DEST}/download` is the path to the directory that contains all | ||
PDF-files and compressed releases (probably `~/apps/flintlib_org/`). | ||
|
||
Following this, generate all HTML pages via | ||
``` | ||
$ python3 build.py ${PATH_TO_DEST} | ||
``` | ||
which outputs all HTML files to `${PATH_TO_DEST}` (probably | ||
`~/apps/flintlib_org/`). | ||
|
||
|
||
|
||
# Source file structure | ||
|
||
In the source directory: | ||
|
||
- `./`: Building scripts are located in the top directory. | ||
- `src/`: Text files that are to be used to generated to HTML files. | ||
|
||
|
||
|
||
# Output file system | ||
|
||
The following directories in the output directory `${PATH_TO_DEST}` needs to be | ||
populated already: | ||
|
||
- `img/`: Images for website, such as figures and picture of authors. | ||
- `download/`: PDF documentation along with releases (`.tar.gz` and `.zip`) | ||
files. |
This file contains 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
Oops, something went wrong.