Merge branch 'Farama-Foundation:master' into master

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: Farama-Foundation
+liberapay: Farama-Foundation
+custom: farama.org/donations

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,51 @@
+name: Bug Report
+description: Submit a bug report
+title: "[Bug Report] Bug title"
+labels: ["bug"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: code-example
+    attributes:
+      label: Code example
+      description: |
+        Bug reports without minimal code examples take 5-10x longer to solve.
+        We'll give you a cookie if you add the stack trace too!
+        Save time, add code.
+        This will be automatically formatted into code, so no need for backticks.
+      render: shell
+
+  - type: textarea
+    id: system-info
+    attributes:
+      label: System info
+      description: |
+        Describe the characteristic of your environment:
+        * Describe how PettingZoo was installed (pip, source, ...)
+        * Version of `pettingzoo` (by `pettingzoo.__version__`)
+        * What OS/version you're using. Note that while we will accept PRs to improve Window's support, we do not officially support it.
+        * Python version
+
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: >
+            I have checked that there is no similar [issue](https://github.com/Farama-Foundation/PettingZoo/issues) in
+            the repo
+          required: true

.github/ISSUE_TEMPLATE/proposal.yml

@@ -0,0 +1,49 @@
+name: Proposal
+description: Propose changes that are not fixing bugs
+title: "[Proposal] Proposal title"
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposal
+      description: A clear and concise description of the proposal.
+    validations:
+      required: true
+
+  - type: textarea
+    id: motivation
+    attributes:
+      label: Motivation
+      description: |
+        Please outline the motivation for the proposal.
+        Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]".
+        If this is related to another GitHub issue, please link here too.
+
+  - type: textarea
+    id: pitch
+    attributes:
+      label: Pitch
+      description: A clear and concise description of what you want to happen.
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: A clear and concise description of any alternative solutions or features you've considered, if any.
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Checklist
+      options:
+        - label: >
+            I have checked that there is no similar [issue](https://github.com/Farama-Foundation/PettingZoo/issues) in
+            the repo
+          required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,22 @@
+name: Question
+description: Ask a question
+title: "[Question] Question title"
+labels: ["question"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        If you have basic questions about reinforcement learning algorithms, please ask on 
+        [r/reinforcementlearning](https://www.reddit.com/r/reinforcementlearning/) or in the 
+        [RL Discord](https://discord.com/invite/xhfNqQv) (if you're new please use the beginners channel). 
+        Basic questions that are not bugs or feature requests will be closed without reply, because GitHub 
+        issues are not an appropriate venue for these. Advanced/nontrivial questions, especially in areas where 
+        documentation is lacking, are very much welcome.
+        
+  - type: textarea
+    id: question
+    attributes:
+      label: Question
+      description: Your question
+    validations:
+      required: true

.github/workflows/build-docs.yml

@@ -8,23 +8,26 @@ jobs:
   docs:
     name: Generate Website
     runs-on: ubuntu-latest
-    
+
     steps:
       - uses: actions/checkout@v3
 
       - uses: actions/setup-python@v4
         with:
-            python-version: '3.9' 
+            python-version: '3.9'
 
       - name: Install dependencies
         run: pip install -r docs/requirements.txt
-      
+
       - name: Install PettingZoo
         run: pip install .
-      
+
       - name: Generate environment docs
         run: python docs/_scripts/gen_envs_mds.py
-
+
+      - name: Generate environments display
+        run: python docs/_scripts/gen_envs_display.py
+
       - name: Build
         run: sphinx-build -b dirhtml -v docs _build
 
@@ -40,4 +43,6 @@ jobs:
       - name: Upload to GitHub Pages
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          folder: _build
+          folder: _build
+          target-folder: main
+          clean: false

.github/workflows/build-publish.yml

@@ -30,6 +30,9 @@ jobs:
         - os: ubuntu-latest
           python: 310
           platform: manylinux_x86_64
+        - os: ubuntu-latest
+          python: 311
+          platform: manylinux_x86_64
 
     steps:
     - uses: actions/checkout@v3

.github/workflows/docs-manual-versioning.yml

@@ -0,0 +1,72 @@
+name: Manual Docs Versioning
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+          description: 'Documentation version to create'
+          required: true
+      commit:
+          description: 'Commit used to build the Documentation version'
+          required: false
+      latest:
+          description: 'Latest version'
+          type: boolean
+
+permissions:
+  contents: write
+jobs:
+  docs:
+    name: Generate Website for new version
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        if: inputs.commit == ''
+
+      - uses: actions/checkout@v3
+        if: inputs.commit != ''
+        with:
+          ref: ${{ inputs.commit }}
+
+      - uses: actions/setup-python@v4
+        with:
+            python-version: '3.9'
+
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Install PettingZoo
+        run: pip install .
+
+      - name: Generate environment docs
+        run: python docs/_scripts/gen_envs_mds.py
+
+      - name: Generate environments display
+        run: python docs/_scripts/gen_envs_display.py
+
+      - name: Build
+        run: sphinx-build -b dirhtml -v docs _build
+
+      - name: Move 404
+        run: mv _build/404/index.html _build/404.html
+
+      - name: Update 404 links
+        run: python docs/_scripts/move_404.py _build/404.html
+
+      - name: Remove .doctrees
+        run: rm -r _build/.doctrees
+
+      - name: Upload to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: _build
+          target-folder: ${{ inputs.version }}
+          clean: false
+
+      - name: Upload to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        if: inputs.latest
+        with:
+          folder: _build
+          clean-exclude: |
+            *.*.*/
+            main

.github/workflows/docs-versioning.yml

@@ -0,0 +1,62 @@
+name: Docs Versioning
+on:
+  push:
+    tags:
+      - 'v?*.*.*'
+permissions:
+  contents: write
+jobs:
+  docs:
+    name: Generate Website for new version
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        with:
+            python-version: '3.9'
+
+      - name: Get tag
+        id: tag
+        uses: dawidd6/action-get-tag@v1
+        with:
+          strip_v: true
+
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Install PettingZoo
+        run: pip install .
+
+      - name: Generate environment docs
+        run: python docs/_scripts/gen_envs_mds.py
+
+      - name: Generate environments display
+        run: python docs/_scripts/gen_envs_display.py
+
+      - name: Build
+        run: sphinx-build -b dirhtml -v docs _build
+
+      - name: Move 404
+        run: mv _build/404/index.html _build/404.html
+
+      - name: Update 404 links
+        run: python docs/_scripts/move_404.py _build/404.html
+
+      - name: Remove .doctrees
+        run: rm -r _build/.doctrees
+
+      - name: Upload to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: _build
+          target-folder: ${{steps.tag.outputs.tag}}
+          clean: false
+
+      - name: Upload to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: _build
+          clean-exclude: |
+            *.*.*/
+            main