Merge pull request #40 from mgoulao/main

Add docs versioning and add missing requirements
Farama-Foundation · Feb 8, 2024 · 425091b · 425091b
2 parents 2835950 + fa51b0c
commit 425091b
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 9 deletions.
diff --git a/.github/workflows/build-docs-version.yml b/.github/workflows/build-docs-version.yml
@@ -18,10 +18,6 @@ jobs:
         with:
             python-version: '3.9'
 
-      - name: Get tag
-        id: tag
-        uses: dawidd6/action-get-tag@v1
-
       - name: Install docs requirements
         run: pip install -r docs/requirements.txt
 
@@ -47,7 +43,7 @@ jobs:
         uses: JamesIves/github-pages-deploy-action@v4
         with:
           folder: _build
-          target-folder: ${{steps.tag.outputs.tag}}
+          target-folder: ${{github.ref_name}}
           clean: false
 
       - name: Upload to GitHub Pages

diff --git a/...ub/workflows/manual-build-docs-version.md → ...b/workflows/manual-build-docs-version.yml b/...ub/workflows/manual-build-docs-version.md → ...b/workflows/manual-build-docs-version.yml
diff --git a/docs/conf.py b/docs/conf.py
@@ -74,7 +74,7 @@
     # "light_logo": "img/PettingZoo.svg",
     # "dark_logo": "img/PettingZoo_White.svg",
     # "gtag": "G-Q4EGMJ3R24",
-    # "versioning": False,
+    "versioning": True,
     "source_repository": "https://github.com/rradules/momaland/",
     "source_branch": "main",
     "source_directory": "docs/",

diff --git a/docs/index.md b/docs/index.md
@@ -53,8 +53,6 @@ Contribute to the Docs <https://github.com/rradules/momaland/tree/master/docs/>
 An API standard for multi-objective multi-agent reinforcement learning (MOMARL)
 ```
 
-# An API standard for multi-objective multi-agent reinforcement learning (MOMARL)
-
 <!-- ```{figure} _static/img/environments-demo.gif TODO
    :width: 480px
    :name: MOMAland Environments

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,5 +3,7 @@ gymnasium
 git+https://github.com/rradules/momaland
 tqdm
 sphinx
-furo
+sphinx-autobuild
 myst-parser
+sphinx_github_changelog
+git+https://github.com/Farama-Foundation/Celshast#egg=furo