Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate changelog #257

Merged
merged 5 commits into from
Jan 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ jobs:
docs:
name: Generate Website
runs-on: ubuntu-latest

env:
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/docs-manual-versioning.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ jobs:
docs:
name: Generate Website for new version
runs-on: ubuntu-latest
env:
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3
if: inputs.commit == ''
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/docs-versioning.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ jobs:
docs:
name: Generate Website for new version
runs-on: ubuntu-latest
env:
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
steps:
- uses: actions/checkout@v3

Expand Down
5 changes: 5 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"sphinx.ext.githubpages",
"myst_parser",
"furo.gen_tutorials",
"sphinx_github_changelog",
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -98,3 +99,7 @@
os.path.dirname(__file__),
os.path.join(os.path.dirname(__file__), "tutorials"),
)

# -- Generate Changelog -------------------------------------------------

sphinx_github_changelog_token = os.environ.get("SPHINX_GITHUB_CHANGELOG_TOKEN")
55 changes: 0 additions & 55 deletions docs/content/release_notes.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,6 @@ tutorials/*
:caption: Development

Github <https://github.com/Farama-Foundation/Gymnasium>
content/release_notes
release_notes/index
Contribute to the Docs <https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/README.md>
```
14 changes: 0 additions & 14 deletions docs/release_notes/gymnasium_v0.26.0.md

This file was deleted.

12 changes: 0 additions & 12 deletions docs/release_notes/gymnasium_v0.26.1.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/release_notes/gymnasium_v0.26.2.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/release_notes/gymnasium_v0.26.3.md

This file was deleted.

82 changes: 0 additions & 82 deletions docs/release_notes/gymnasium_v0.27.0.md

This file was deleted.

Loading