Skip to content

Commit ed329e7

Browse files
committed
add release notes
1 parent b0f00d0 commit ed329e7

File tree

4 files changed

+20
-3
lines changed

4 files changed

+20
-3
lines changed

docs/source/conf.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
project = 'PySHRED'
1010
copyright = '2025, Kutz Research Group'
1111
author = 'Kutz Research Group'
12-
version = '1.0.0'
12+
version = 'v1.0.0'
1313

1414
# -- General configuration ---------------------------------------------------
1515
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -55,4 +55,6 @@
5555

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

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,5 @@ PySHRED is an open-source software implementing the SHallow REcurrent Decoder (S
9696

9797
User Guide <user_guide/index>
9898
Example Gallery <examples/index>
99-
API Reference <pyshred/modules>
99+
API Reference <pyshred/modules>
100+
Release Notes <release_notes/index>
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Release Notes
2+
=============
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
v1_0_0
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Release Notes
2+
3+
## v1.0.0 — Initial Launch
4+
5+
Released: 2025-06-14
6+
7+
🎉 PySHRED v1.0.0 marks the first official release!

0 commit comments

Comments
 (0)