Skip to content

Sphinx docs and gym README - #10

Merged
elprofesoriqo merged 8 commits into
feat/gym-clifrom
feat/sphinx-docs
Sep 20, 2026
Merged

elprofesoriqo merged 8 commits into
feat/gym-clifrom
feat/sphinx-docs

Conversation

@elprofesoriqo

Copy link
Copy Markdown
Collaborator

Summary

  • Replace MkDocs with Sphinx + Furo (FlowEdge parchment/wine, Excalidraw figures).
  • Rewrite README and docs around the cybersecurity RL gym: SIEM vs oracle, first run, Arena, packs.
  • No Light/Dark/Auto picker; theme follows the browser. Keep arXiv citation and CybORG/DSTG license notes.

Test plan

  • pip install -e ".[docs]"
  • sphinx-build -b html -W --keep-going docs docs/_build/html
  • Open docs/_build/html/index.html and confirm nav has no Light/Dark/Auto controls

Checklist

  • One issue, one PR
  • Tests added or updated
  • Did not vendor a training algorithm (MAPPO / QMIX / CT-GMARL stay out of tree)
  • User-path docs updated only if the user path changed

Stacked on #9. Retarget to main after #9 merges.

elprofesoriqo and others added 5 commits September 20, 2026 15:15
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>
@elprofesoriqo elprofesoriqo mentioned this pull request Sep 20, 2026
3 of 7 tasks

@elprofesoriqo elprofesoriqo left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Reviewed the Sphinx/README stack (5 commits). Merge after #9; retarget to main then.

Looks good

  • MkDocs is gone; Sphinx -W is 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 main and the CybORG/DSTG license note.

Notes (non-blocking)

  • DATASHEET.md exists at repo root and as docs/DATASHEET.md. Fine if intentional; otherwise pick one.
  • README already mentions docs.yml / GitHub Pages. That workflow arrives in #11.

elprofesoriqo and others added 3 commits September 20, 2026 15:22
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>
@elprofesoriqo
elprofesoriqo merged commit 7a53bdb into feat/gym-cli Sep 20, 2026
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.

1 participant