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

Add basic CI to test documentation (using pytest-markdown-docs) #153

Merged
merged 31 commits into from Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
45eeb26
Add basic documentation testing GitHub action (has two errors current…
elliottower Oct 18, 2023
042dd0f
Fix typo in newdoctest yml
elliottower Oct 18, 2023
f566d18
Merge remote-tracking branch 'origin/main' into docs-tests
elliottower Oct 18, 2023
c374218
Change CI to run every PR and not require write privileges
elliottower Oct 18, 2023
9ad4418
fix doc generation
younik Oct 20, 2023
a941002
fix docs code
younik Oct 20, 2023
85fd740
remove BC tutorial testing
younik Oct 20, 2023
c9dc074
fix ignore path
younik Oct 20, 2023
00db31e
try addopts
younik Oct 20, 2023
1e793f5
add minigrid dependency on testing for docs
younik Oct 20, 2023
eac2302
Fix addopts to skip behavioral cloning tutorial
elliottower Oct 20, 2023
879131b
support env_spec=None in docs
younik Oct 20, 2023
b8e4be6
Merge branch 'docs-tests' of https://github.com/Farama-Foundation/Min…
younik Oct 20, 2023
8cc2d45
fix pre-commit
younik Oct 20, 2023
c315912
fix markdown tests
younik Oct 23, 2023
51bac46
fix add_to_dataset
younik Oct 23, 2023
5fc3246
Merge remote-tracking branch 'farama/main' into docs-tests
younik Oct 23, 2023
1f49ce0
add nbmake
younik Oct 23, 2023
7ad4845
restore ignore tutorials for markdown
younik Oct 24, 2023
f43d83d
make point_maze_tutorial faster
younik Oct 24, 2023
c4e909e
fix pre-commit + make poin_maze tutorial faster
younik Oct 25, 2023
d460474
restore gen_dataset to not conflict rodrigo's pr
younik Oct 25, 2023
ccf3c30
make point maze tutorial faster
younik Oct 25, 2023
96aaba6
Fix CI to run on the correct PRs/publish actions
elliottower Oct 26, 2023
d58a84c
Make pre-commit match existing yml (any PR, and push to main), mirror…
elliottower Oct 26, 2023
96eb350
Test adding pytest xdist to docs test to speed it up using multiproce…
elliottower Oct 26, 2023
b001b05
Revert xdist, doesn't work with async opening of h5py files
elliottower Oct 26, 2023
063451a
Update build-docs.yml
elliottower Oct 26, 2023
32ca642
Update docs-test.yml
elliottower Oct 26, 2023
2a98f76
fix pre-commit
younik Oct 26, 2023
7a81f28
add minigrid version
younik Oct 26, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs-test.yml
Expand Up @@ -37,4 +37,4 @@ jobs:
run: rm -r _build/.doctrees

- name: Run documentation tests
run: xvfb-run -s "-screen 0 1024x768x24" pytest docs --markdown-docs -m markdown-docs —-ignore=tutorials/using_datasets/behavioral_cloning.py
run: xvfb-run -s "-screen 0 1024x768x24" pytest docs --markdown-docs -m markdown-docs
1 change: 1 addition & 0 deletions pyproject.toml
Expand Up @@ -106,3 +106,4 @@ reportUnboundVariable = "warning"
[tool.pytest.ini_options]
filterwarnings = ['ignore:.*The environment .* is out of date.*']
# filterwarnings = ['ignore:.*step API.*:DeprecationWarning']
addopts = --ignore=docs/tutorials/using_datasets/behavioral_cloning.py
elliottower marked this conversation as resolved.
Show resolved Hide resolved