Generate changelog (openai#257)

RetroAI · Jan 11, 2023 · 35fe9b0 · 35fe9b0
1 parent febe526
commit 35fe9b0
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 215 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -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
 

diff --git a/.github/workflows/docs-manual-versioning.yml b/.github/workflows/docs-manual-versioning.yml
@@ -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 == ''

diff --git a/.github/workflows/docs-versioning.yml b/.github/workflows/docs-versioning.yml
@@ -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
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -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.
@@ -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")
diff --git a/docs/content/release_notes.md b/docs/content/release_notes.md
diff --git a/docs/index.md b/docs/index.md
@@ -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>
 ```
diff --git a/docs/release_notes/gymnasium_v0.26.0.md b/docs/release_notes/gymnasium_v0.26.0.md
diff --git a/docs/release_notes/gymnasium_v0.26.1.md b/docs/release_notes/gymnasium_v0.26.1.md
diff --git a/docs/release_notes/gymnasium_v0.26.2.md b/docs/release_notes/gymnasium_v0.26.2.md
diff --git a/docs/release_notes/gymnasium_v0.26.3.md b/docs/release_notes/gymnasium_v0.26.3.md
diff --git a/docs/release_notes/gymnasium_v0.27.0.md b/docs/release_notes/gymnasium_v0.27.0.md