Repository navigation
Sphinx docs and gym README - #10
Merged
Merged
Conversation
Stop ignoring the docs tree so Sphinx sources are versioned; keep docs/_build and site/ out of git. Co-authored-by: Cursor <cursoragent@cursor.com>
…kit. Lead with SIEM vs oracle, PettingZoo/Gymnasium ids, and leave MAPPO/QMIX out of tree. Co-authored-by: Cursor <cursoragent@cursor.com>
These document the gym CLI and eval splits so users do not have to reverse-engineer the code. Co-authored-by: Cursor <cursoragent@cursor.com>
Drop the Light/Dark/Auto picker so Furo follows the browser color scheme only. Co-authored-by: Cursor <cursoragent@cursor.com>
Keep the arXiv citation and CybORG/DSTG license notices. Co-authored-by: Cursor <cursoragent@cursor.com>
3 of 7 tasks
elprofesoriqo
commented
Sep 20, 2026
elprofesoriqo
left a comment
Collaborator
Author
There was a problem hiding this comment.
Reviewed the Sphinx/README stack (5 commits). Merge after #9; retarget to main then.
Looks good
- MkDocs is gone; Sphinx
-Wis the documented gate. - Light / Dark / Auto controls are removed from the custom nav, and Furo's theme toggle is hidden. Browser color-scheme still applies.
- README keeps the arXiv citation from
mainand the CybORG/DSTG license note.
Notes (non-blocking)
DATASHEET.mdexists at repo root and asdocs/DATASHEET.md. Fine if intentional; otherwise pick one.- README already mentions
docs.yml/ GitHub Pages. That workflow arrives in #11.
Unindent the evaluate command in the docstring and construct FrameRecorder before asserting empty save. Co-authored-by: Cursor <cursoragent@cursor.com>
Ruff 0.16 treats a bare ignore list as a much larger rule set, which fails on the existing simulator files. Co-authored-by: Cursor <cursoragent@cursor.com>
Quote style is single, including fenced examples and the figure builder. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
pip install -e ".[docs]"sphinx-build -b html -W --keep-going docs docs/_build/htmldocs/_build/html/index.htmland confirm nav has no Light/Dark/Auto controlsChecklist
Stacked on #9. Retarget to
mainafter #9 merges.