Add Sphinx documentation build with PyTorch theme v3#408
Add Sphinx documentation build with PyTorch theme v3#408sekyondaMeta wants to merge 22 commits intometa-pytorch:mainfrom
Conversation
…r merge)" This reverts commit 3e99d68.
|
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).
- 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).
|
@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. You can also see a preview of the site built from this PR by downloading the link below and running a python server: Thanks for the feedback |
|
@init27 Let me know if you see anything off wit this PR |
AlirezaShamsoshoara
left a comment
There was a problem hiding this comment.
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
|
@sekyondaMeta no further comments here and great work. Please import it to fbsource |
|
@sekyondaMeta has imported this pull request. If you are a Meta employee, you can view this in D94541448. |
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.