Skip to content

Add Sphinx documentation build with PyTorch theme v3#408

Open
sekyondaMeta wants to merge 22 commits intometa-pytorch:mainfrom
sekyondaMeta:sphinxv3
Open

Add Sphinx documentation build with PyTorch theme v3#408
sekyondaMeta wants to merge 22 commits intometa-pytorch:mainfrom
sekyondaMeta:sphinxv3

Conversation

@sekyondaMeta
Copy link
Contributor

@sekyondaMeta sekyondaMeta commented Feb 25, 2026

Summary

Re-lands the Sphinx documentation build for OpenEnv (originally PR #401, which was accidentally merged and reverted).

This reverts the revert commit to restore all documentation changes.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Feb 25, 2026
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 25, 2026

PR title or description contains an excluded keyword.

- Add getting_started/README.rst to exclude_patterns (Sphinx Gallery
  already generates auto_getting_started/index.rst from it)
- Update environment-builder.md references in cli.md, core.md,
  environments.md, and auto-discovery.md to use auto_getting_started/ path
- Update tutorials/index.md and rl-training-2048.md to reference
  auto_getting_started/index instead of getting_started/README.rst
- Add title to connect4.md for empty included README
- Add rl-training-2048.md tutorial page

Reduces build warnings from 99 to 57 (all remaining are pre-existing).
@sekyondaMeta sekyondaMeta changed the title Add Sphinx documentation build with PyTorch theme (v3) Add Sphinx documentation build with PyTorch theme v3 Feb 25, 2026
- Add explicit MyST anchor targets to 12 headings in openenv-tutorial.md
  so table-of-contents links resolve correctly (emoji in headings caused
  slug mismatches)
- Change Jupyter magic code blocks from python to ipython3/bash to fix
  lexer errors on '!' and '%' syntax (openenv-tutorial.md, rl-training-2048.md)
- Change math expression code block from python to text in wildfire README

Build warnings: 50 → 35 (remaining are env README/docstring issues).
The openspiel-env Docker image is not yet published to GHCR,
causing 'manifest unknown' failures. Commenting out the service
container until the image is available (see PR meta-pytorch#400).
… clients

Expanded core.md from 6 modules to 18, organized into sections:
- Server: interfaces, types, exceptions, HTTP server, web interface,
  serialization, transforms, route config
- Clients: base, sync, generic, LLM, shared dataclasses
- MCP: environment, types, client
- Rubrics: base, containers, trajectory, LLM judge
- Tools: git server client
- Container providers: Docker, UV

Excluded local_python_executor (requires optional smolagents dep).
@sekyondaMeta
Copy link
Contributor Author

@AlirezaShamsoshoara Had to close the other PR (accidentally merged it and had to revert it). This is the new one and it should address most/if not all the comments you had.
Let me know if you see anything else.

You can also see a preview of the site built from this PR by downloading the link below and running a python server:
https://github.com/meta-pytorch/OpenEnv/actions/runs/22415570596/artifacts/5661529256

Thanks for the feedback

@sekyondaMeta
Copy link
Contributor Author

@init27 Let me know if you see anything off wit this PR

Copy link
Member

@AlirezaShamsoshoara AlirezaShamsoshoara left a comment

Choose a reason for hiding this comment

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

Thanks for reverting the 401 PR (not supposed to be merged) and raise a new PR (408).
Looks good to me. I just had two comments I addressed here

@AlirezaShamsoshoara
Copy link
Member

@sekyondaMeta no further comments here and great work. Please import it to fbsource

@meta-codesync
Copy link

meta-codesync bot commented Feb 27, 2026

@sekyondaMeta has imported this pull request. If you are a Meta employee, you can view this in D94541448.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants