Skip to content

Commit d0c64a6

Browse files
mariaob1201mariaob1201
authored
Merge pull request #32 from UW-Madison-DSI/feature
refine doc structure
2 parents fb4a916 + 54a0408 commit d0c64a6

File tree

273 files changed

+28162
-172
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

273 files changed

+28162
-172
lines changed

‎.github/workflows/publish.yml‎

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@ concurrency:
1313
group: pages
1414
cancel-in-progress: false
1515

16-
env:
17-
BASE_URL: /${{ github.event.repository.name }}
18-
1916
jobs:
2017
deploy:
2118
environment:
@@ -39,46 +36,20 @@ jobs:
3936
- name: Install dependencies
4037
run: |
4138
python -m pip install --upgrade pip
42-
pip install -U jupyter-book
43-
pip install -U pandas
39+
pip install 'jupyter-book<2.0'
40+
pip install -U pandas
4441
pip install -U plotly
4542
pip install -U matplotlib
4643
47-
- name: Debug - Check docs directory
48-
run: |
49-
echo "Root directory contents:"
50-
ls -la
51-
echo ""
52-
echo "Docs directory contents:"
53-
if [ -d "docs" ]; then
54-
ls -la docs/
55-
else
56-
echo "No docs directory found!"
57-
exit 1
58-
fi
59-
6044
- name: Build Jupyter Book
61-
working-directory: docs
45+
working-directory: survey_results_docs/docs
6246
run: jupyter-book build .
6347

64-
- name: List build output
65-
run: |
66-
echo "Build output in docs/_build:"
67-
ls -la docs/_build/ || echo "No _build directory"
68-
echo ""
69-
if [ -d "docs/_build/html" ]; then
70-
echo "HTML build contents:"
71-
ls -la docs/_build/html/
72-
else
73-
echo "No HTML build directory found!"
74-
exit 1
75-
fi
76-
7748
- name: Upload artifact
7849
uses: actions/upload-pages-artifact@v3
7950
with:
80-
path: docs/_build/html
51+
path: survey_results_docs/docs/_build/html
8152

8253
- name: Deploy to GitHub Pages
8354
id: deployment
84-
uses: actions/deploy-pages@v4
55+
uses: actions/deploy-pages@v4

‎docs/custom-footer.css‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎survey_results_docs/.github/.github/workflows/publish.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Deploy {{ cookiecutter.project_name }} to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ publishing ]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
env:
17+
BASE_URL: /{{ cookiecutter.repo_name }}
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: 🧹 Checkout repository
28+
uses: actions/checkout@v4
29+
30+
- name: ⚙️ Setup Pages
31+
uses: actions/configure-pages@v5
32+
with:
33+
enablement: true
34+
35+
- name: 🐍 Setup Python
36+
uses: actions/setup-python@v5
37+
with:
38+
python-version: '3.11'
39+
40+
- name: 📦 Install dependencies
41+
run: |
42+
python -m pip install --upgrade pip
43+
pip install -U jupyter-book pandas plotly matplotlib
44+
45+
- name: 🔍 Debug - Check docs directory
46+
run: |
47+
echo "Root directory contents:"
48+
ls -la
49+
echo ""
50+
echo "Docs directory contents:"
51+
if [ -d "docs" ]; then
52+
ls -la docs/
53+
else
54+
echo "No docs directory found!"
55+
exit 1
56+
fi
57+
58+
- name: 🏗️ Build Jupyter Book
59+
working-directory: docs
60+
run: jupyter-book build .
61+
62+
- name: 📁 List build output
63+
run: |
64+
echo "Build output in docs/_build:"
65+
ls -la docs/_build/
66+
echo ""
67+
if [ -d "docs/_build/html" ]; then
68+
echo "HTML build contents:"
69+
ls -la docs/_build/html/
70+
else
71+
echo "No HTML build directory found!"
72+
fi
73+
74+
- name: 📤 Upload artifact
75+
uses: actions/upload-pages-artifact@v3
76+
with:
77+
path: docs/_build/html
78+
79+
- name: 🚀 Deploy to GitHub Pages
80+
id: deployment
81+
uses: actions/deploy-pages@v4

‎survey_results_docs/.github/workflows/publish.yml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Deploy {{ cookiecutter.project_name }} to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ publishing ]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
env:
17+
BASE_URL: /{{ cookiecutter.repo_name }}
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
26+
steps:
27+
- name: 🧹 Checkout repository
28+
uses: actions/checkout@v4
29+
30+
- name: ⚙️ Setup Pages
31+
uses: actions/configure-pages@v5
32+
with:
33+
enablement: true
34+
35+
- name: 🐍 Setup Python
36+
uses: actions/setup-python@v5
37+
with:
38+
python-version: '3.11'
39+
40+
- name: 📦 Install dependencies
41+
run: |
42+
python -m pip install --upgrade pip
43+
pip install -U jupyter-book pandas plotly matplotlib
44+
45+
- name: 🔍 Debug - Check docs directory
46+
run: |
47+
echo "Root directory contents:"
48+
ls -la
49+
echo ""
50+
echo "Docs directory contents:"
51+
if [ -d "docs" ]; then
52+
ls -la docs/
53+
else
54+
echo "No docs directory found!"
55+
exit 1
56+
fi
57+
58+
- name: 🏗️ Build Jupyter Book
59+
working-directory: docs
60+
run: jupyter-book build .
61+
62+
- name: 📁 List build output
63+
run: |
64+
echo "Build output in docs/_build:"
65+
ls -la docs/_build/
66+
echo ""
67+
if [ -d "docs/_build/html" ]; then
68+
echo "HTML build contents:"
69+
ls -la docs/_build/html/
70+
else
71+
echo "No HTML build directory found!"
72+
fi
73+
74+
- name: 📤 Upload artifact
75+
uses: actions/upload-pages-artifact@v3
76+
with:
77+
path: docs/_build/html
78+
79+
- name: 🚀 Deploy to GitHub Pages
80+
id: deployment
81+
uses: actions/deploy-pages@v4

‎survey_results_docs/CITATION.cff‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
cff-version: 1.2.0
2+
message: "Please cite this work when using the software."
3+
type: software
4+
5+
title: "{{ cookiecutter.project_name }}"
6+
authors:
7+
- family-names: "Cranmer"
8+
given-names: "Kyle"
9+
orcid: "https://orcid.org/0000-0002-5769-7094"
10+
affiliation: "{{ cookiecutter.author_affiliation }}"
11+
- family-names: "Kittinger"
12+
given-names: "Allison"
13+
orcid: "https://orcid.org/0000-0002-3104-5995"
14+
affiliation: "{{ cookiecutter.author_affiliation }}"
15+
- family-names: "Baumann"
16+
given-names: "Isaac"
17+
orcid: "https://orcid.org/0009-0001-4028-1324"
18+
affiliation: "{{ cookiecutter.author_affiliation }}"
19+
- family-names: "Oros"
20+
given-names: "Maria"
21+
orcid: "https://orcid.org/0009-0006-2067-4063"
22+
affiliation: "{{ cookiecutter.author_affiliation }}"
23+
- family-names: "Philbrick"
24+
given-names: "Bethany"
25+
orcid: "https://orcid.org/0009-0000-0872-5194"
26+
affiliation: "{{ cookiecutter.author_affiliation }}"
27+
- family-names: "Feickert"
28+
given-names: "Matthew"
29+
orcid: "https://orcid.org/0000-0003-4124-7862"
30+
affiliation: "{{ cookiecutter.author_affiliation }}"
31+
32+
doi: "10.5281/zenodo.17379408"
33+
repository-code: "https://github.com/UW-Madison-DSI/open_source_survey_results_myst.git"
34+
url: "https://github.com/UW-Madison-DSI/open_source_survey_results.git"
35+
license: "MIT"
36+
keywords:
37+
- open source
38+
- survey
39+
- UW–Madison
40+
41+
abstract: |
42+
In Spring 2024, the Open Source Program Office at UW–Madison distributed a survey
43+
to gauge the usage of open source tools across the university community, identify
44+
projects under development, and collect feedback on improving the open source
45+
environment. This repository hosts a MyST site that summarizes and presents
46+
the survey results.

‎survey_results_docs/LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 UW-Madison Data Science Institute
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)