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

Wrappers doctests #1083

Merged
merged 28 commits into from
Sep 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4e5d284
Fix syntax/imports and add TODOs/notests in docs
Bamboofungus Aug 24, 2023
21fcd43
Merge branch 'Farama-Foundation:master' into pytest-markdown-docs-test
Bamboofungus Aug 30, 2023
c66a730
Fix some errors and add typing to render_test
Bamboofungus Sep 1, 2023
b357bb3
Clean up wrappers code, TerminateIllegal support info action masks, u…
elliottower Sep 1, 2023
e816cc3
Pre-commit, add ignore for tutorials on pytest by default, add ci tes…
elliottower Sep 1, 2023
32bc727
Add pytest markdown docs requirement
elliottower Sep 1, 2023
cf0b35d
Add pytest xdist by default to pytest (speeds tests up immensely), ig…
elliottower Sep 1, 2023
2129aad
pre-commit, clean up conftest
elliottower Sep 1, 2023
fe3123c
Fix various minor bugs and remove some notest parts
elliottower Sep 1, 2023
287f3b6
Add xvfb to allow doctest to work with human rendering
elliottower Sep 1, 2023
2125133
test running the linux tutorials in parallel for a given directory/te…
elliottower Sep 1, 2023
dade74e
Add supersuit and shimmy to docs test ci
elliottower Sep 1, 2023
a3b953e
Pre-commit cleanup CI
elliottower Sep 1, 2023
6d39d5a
Test coverage in CI (probably will remove)
elliottower Sep 1, 2023
5810b03
Merge remote-tracking branch 'upstream/master' into wrappers-doctests
elliottower Sep 1, 2023
60e6e39
Clean up
elliottower Sep 1, 2023
c323726
Add doctests for all env mds as well
elliottower Sep 2, 2023
f109783
Add imports for all modules, allow testing of in-line argument exampl…
elliottower Sep 2, 2023
7eaf9ca
pre-commit
elliottower Sep 2, 2023
9e347a2
Test using pytest split with docs test to speed up (28 tests was 10 m…
elliottower Sep 2, 2023
f52aa9a
Test using pytest split with docs test to speed up (28 tests was 10 m…
elliottower Sep 2, 2023
618e322
Add pytest-split install
elliottower Sep 2, 2023
0179526
Fix some of the documentation bugs
elliottower Sep 3, 2023
0c3c9ed
Add temp testing code to download artifacts and combine durations, fi…
elliottower Sep 3, 2023
150db6a
Add yml formatter to fix weird formatting inconsistencies, fix bug of…
elliottower Sep 3, 2023
097aab8
Add move test durations from subfolder to root directory so script works
elliottower Sep 4, 2023
a06745a
Fix yml typo
elliottower Sep 4, 2023
5da1816
Ensure github workflow passes even if the uplaod timings fails
elliottower Sep 4, 2023
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
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
---
github: Farama-Foundation
87 changes: 44 additions & 43 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -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
83 changes: 42 additions & 41 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -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
37 changes: 19 additions & 18 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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
71 changes: 36 additions & 35 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -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
Loading