Skip to content

Commit 4e3f7f8

Browse files
authored
Adding support for autogenerated changelog (#31)
* starting to add support for autogenerated changelog * updating token * removing stuff needed during testing
1 parent d29b26e commit 4e3f7f8

File tree

5 files changed

+20
-1
lines changed

5 files changed

+20
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Strøm
1+
# STRØM
22
**An Open Wifi Speaker**
33

44
The _Strøm_ open source speaker project have been started with the main goal of creating a fully functional "wifi speaker", but as an open sourced product.

docs/source/changelog.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Changelog
2+
#########
3+
4+
.. changelog::
5+
:changelog-url: https://stroem.readthedocs.io/en/latest/changelog.html
6+
:github: https://github.com/LydByDissing/stroem/releases/

docs/source/conf.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
'myst_parser',
3939
'sphinxemoji.sphinxemoji',
4040
'sphinx_last_updated_by_git',
41+
'sphinx_github_changelog',
4142
]
4243

4344
sphinxemoji_style = 'twemoji'
@@ -62,10 +63,20 @@
6263
exclude_patterns = []
6364

6465

66+
67+
68+
6569
## Toolbox options
6670
#github_username = 'LydByDissing'
6771
#github_repository = 'stroem'
6872

73+
# Provide a GitHub API token:
74+
# Pass the SPHINX_GITHUB_CHANGELOG_TOKEN environment variable to your build
75+
# OR
76+
#sphinx_github_changelog_token =
77+
78+
79+
6980
# -- Options for HTML output -------------------------------------------------
7081

7182
# The theme to use for HTML and HTML Help pages. See the documentation for

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ The *Strøm* open source speaker project have been started with the main goal of
1919
contributing
2020
license
2121
todo
22+
changelog
2223

2324
Read on below to get a high level `Introduction to the project`_ as a whole.
2425

docs/source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ myst-parser>=0.17.2
1818
sphinxemoji>=0.2.0
1919
sphinx-last-updated-by-git>=0.3.2
2020
schemdraw>=0.14
21+
sphinx-github-changelog>=1.2.0

0 commit comments

Comments
 (0)