Wrappers doctests (#1083)

Co-authored-by: Bamboofungus <[email protected]> Co-authored-by: Anthony Chang <[email protected]>
Farama-Foundation · Sep 4, 2023 · e5f03f7 · e5f03f7
1 parent ace9b76
commit e5f03f7
Show file tree

Hide file tree

Showing 40 changed files with 708 additions and 535 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1,2 @@
+---
 github: Farama-Foundation
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -1,51 +1,52 @@
+---
 name: Bug Report
 description: Submit a bug report
-title: "[Bug Report] Bug title"
-labels: ["bug"]
+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: 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: 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: 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: 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
+    - 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
diff --git a/.github/ISSUE_TEMPLATE/proposal.yml b/.github/ISSUE_TEMPLATE/proposal.yml
@@ -1,49 +1,50 @@
+---
 name: Proposal
 description: Propose changes that are not fixing bugs
-title: "[Proposal] Proposal title"
-labels: ["enhancement"]
+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: 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: 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: 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: 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: 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
+    - 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
diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml
@@ -1,22 +1,23 @@
+---
 name: Question
 description: Ask a question
-title: "[Question] Question title"
-labels: ["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: 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
+    - type: textarea
+      id: question
+      attributes:
+          label: Question
+          description: Your question
+      validations:
+          required: true
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -1,49 +1,50 @@
+---
 name: Build Documentation website
 on:
-  push:
-    branches: [master]
+    push:
+        branches: [master]
 permissions:
-  contents: write
+    contents: write
 jobs:
-  docs:
-    name: Generate Website
-    runs-on: ubuntu-latest
-    env:
-      SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-    steps:
-      - uses: actions/checkout@v3
+    docs:
+        name: Generate Website
+        runs-on: ubuntu-latest
+        env:
+            SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        steps:
+            - uses: actions/checkout@v3
 
-      - uses: actions/setup-python@v4
-        with:
-            python-version: '3.9'
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: '3.9'
 
-      - name: Install dependencies
-        run: pip install -r docs/requirements.txt
+            - name: Install dependencies
+              run: pip install -r docs/requirements.txt
 
-      - name: Install PettingZoo
-        run: pip install .[all]
+            - name: Install PettingZoo
+              run: pip install .[all]
 
-      - name: Generate environment docs
-        run: python docs/_scripts/gen_envs_mds.py
+            - 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: Generate environments display
+              run: python docs/_scripts/gen_envs_display.py
 
-      - name: Build
-        run: sphinx-build -b dirhtml -v docs _build
+            - name: Build
+              run: sphinx-build -b dirhtml -v docs _build
 
-      - name: Move 404
-        run: mv _build/404/index.html _build/404.html
+            - 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: Update 404 links
+              run: python docs/_scripts/move_404.py _build/404.html
 
-      - name: Remove .doctrees
-        run: rm -r _build/.doctrees
+            - 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: main
-          clean: false
+            - name: Upload to GitHub Pages
+              uses: JamesIves/github-pages-deploy-action@v4
+              with:
+                  folder: _build
+                  target-folder: main
+                  clean: false