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

Fix syntax/imports for python blocks in /docs #1075

Closed
wants to merge 3 commits into from
Closed

Fix syntax/imports for python blocks in /docs #1075

wants to merge 3 commits into from

Conversation

Bamboofungus
Copy link
Contributor

Description

  • Fixes errors found after running pytest-markdown-docs
  • Adds notest to python markdown blocks that I either don't know how to resolve the errors, are supposed to fail (Like the one for DeprecatedModule), or have too many side effects

To test:

pip install pytest-markdown-docs
pytest docs --markdown-docs -m markdown-docs --ignore=docs/_scripts

(I'm skipping the /_scripts folder since trying to test those creates a lot of files atm)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.
To upload images to a PR -- simply drag and drop or copy paste.

Checklist:

  • I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
  • I have run pytest -v and no errors are present.
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I solved any possible warnings that pytest -v has generated that are related to my code to the best of my knowledge.
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

docs/api/parallel.md Outdated Show resolved Hide resolved
from shimmy import DmControlMultiAgentCompatibilityV0
#TODO ModuleNotFoundError: No module named 'dm_control'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one requires pip install shimmy[dm-control] or all, I think it’s possible to make a pytest fixture or some sort of thing to basically say when doing import shimmy, we have to install it (or mock it but ideally it would actually test it)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’d have to test locally but my guess is if the pytest docs can run the pettingzoo scripts then we can have it install shimmy as well.

@elliottower
Copy link
Contributor

@Bamboofungus tagging you just in case you missed my comments

@elliottower
Copy link
Contributor

Closing in favor of other PR #1083

@elliottower elliottower closed this Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants