Skip to content

Commit

Permalink
Adding support for autogenerated changelog (#31)
Browse files Browse the repository at this point in the history
* starting to add support for autogenerated changelog

* updating token

* removing stuff needed during testing
  • Loading branch information
TooDissing authored Aug 5, 2022
1 parent d29b26e commit 4e3f7f8
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Strøm
# STRØM
**An Open Wifi Speaker**

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.
Expand Down
6 changes: 6 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Changelog
#########

.. changelog::
:changelog-url: https://stroem.readthedocs.io/en/latest/changelog.html
:github: https://github.com/LydByDissing/stroem/releases/
11 changes: 11 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
'myst_parser',
'sphinxemoji.sphinxemoji',
'sphinx_last_updated_by_git',
'sphinx_github_changelog',
]

sphinxemoji_style = 'twemoji'
Expand All @@ -62,10 +63,20 @@
exclude_patterns = []





## Toolbox options
#github_username = 'LydByDissing'
#github_repository = 'stroem'

# Provide a GitHub API token:
# Pass the SPHINX_GITHUB_CHANGELOG_TOKEN environment variable to your build
# OR
#sphinx_github_changelog_token =



# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The *Strøm* open source speaker project have been started with the main goal of
contributing
license
todo
changelog

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

Expand Down
1 change: 1 addition & 0 deletions docs/source/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ myst-parser>=0.17.2
sphinxemoji>=0.2.0
sphinx-last-updated-by-git>=0.3.2
schemdraw>=0.14
sphinx-github-changelog>=1.2.0

0 comments on commit 4e3f7f8

Please sign in to comment.