Skip to content

Commit 87919b8

Browse files
davidye007davidye007
committed
update docs versioning
1 parent ffa9c42 commit 87919b8

File tree

4 files changed

+77
-12
lines changed

4 files changed

+77
-12
lines changed

‎.github/workflows/sphinx.yml‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,17 @@ jobs:
3030
with:
3131
name: html-docs
3232
path: docs/build/html/
33-
- name: Deploy
33+
- name: Add root index.html
34+
run: |
35+
cp docs/source/index.html docs/build/html/index.html
36+
- name: Copy latest version to stable
37+
run: |
38+
mkdir -p docs/build/html/stable
39+
cp -r docs/build/html/v1.0.0/* docs/build/html/stable/
40+
- name: Deploy docs (all versions + stable alias)
3441
uses: peaceiris/actions-gh-pages@v3
3542
if: github.ref == 'refs/heads/main'
3643
with:
3744
github_token: ${{ secrets.GITHUB_TOKEN }}
38-
publish_dir: docs/build/html/v1.0.0
45+
publish_dir: docs/build/html
3946
force_orphan: true

‎docs/source/_static/versions.json‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
[
2+
{
3+
"version": "main",
4+
"url": "/pyshred/main/",
5+
"label": "development"
6+
},
7+
{
8+
"version": "stable",
9+
"url": "/pyshred/stable/",
10+
"label": "stable"
11+
},
212
{
313
"version": "v1.0.0",
4-
"url": "/v1.0.0/"
14+
"url": "/pyshred/v1.0.0/"
515
}
616
]

‎docs/source/conf.py‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,4 @@
5555

5656
html_theme = "pydata_sphinx_theme"
5757
html_static_path = ['_static']
58-
html_title = "PySHRED"
59-
60-
# html_baseurl = 'https://pyshred-dev.github.io/pyshred/'
58+
html_title = "PySHRED"

‎docs/source/index.html‎

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,57 @@
1-
Welcome to PySHRED documentation
2-
=================================
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<title>PySHRED Documentation</title>
6+
<style>
7+
body {
8+
font-family: sans-serif;
9+
max-width: 800px;
10+
margin: 2rem auto;
11+
padding: 1rem;
12+
line-height: 1.6;
13+
}
14+
h1 {
15+
text-align: center;
16+
font-size: 2em;
17+
}
18+
ul {
19+
list-style: none;
20+
padding: 0;
21+
}
22+
li {
23+
margin: 0.5em 0;
24+
}
25+
a {
26+
color: #007acc;
27+
text-decoration: none;
28+
font-weight: bold;
29+
}
30+
a:hover {
31+
text-decoration: underline;
32+
}
33+
.links {
34+
margin-top: 2rem;
35+
}
36+
.desc {
37+
margin-top: 2rem;
38+
font-style: italic;
39+
}
40+
</style>
41+
</head>
42+
<body>
43+
<h1>Welcome to the PySHRED documentation</h1>
344

4-
Select a version:
5-
6-
- `Main (development) <main/index.html>`__
7-
- `v1.0.0 (stable) <v1.0.0/index.html>`__
45+
<p>Select a version of the documentation:</p>
46+
<ul>
47+
<li>
48+
<a href="main/index.html">Main (development)</a> — Latest development
49+
build.
50+
</li>
51+
<li><a href="stable/index.html">Stable</a> — Latest official release.</li>
52+
<li>
53+
<a href="v1.0.0/index.html">v1.0.0</a> — Specific version release.
54+
</li>
55+
</ul>
56+
</body>
57+
</html>

0 commit comments

Comments
 (0)