Conversation
There was a problem hiding this comment.
Pull request overview
Fixes the Sphinx API reference page for embodichain.agents.rl by explicitly documenting RL submodules so their public classes/functions appear in generated docs.
Changes:
- Removes a malformed/indented module title line so the
embodichain.agentspage renders correctly. - Adds explicit
.. automodule::sections forembodichain.agents.rl.{algo,buffer,models,train,utils}to surface RL APIs in the docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| :show-inheritance: | ||
|
|
||
| Policy Models | ||
| ------------ |
There was a problem hiding this comment.
The section underline for "Policy Models" is shorter than the title text. While Sphinx/docutils often tolerates this, it can lead to incorrect section parsing in some configurations. Consider extending the underline to match the full title length for robustness.
| ------------ | |
| ------------- |
| :show-inheritance: | ||
|
|
||
| Utilities | ||
| -------- |
There was a problem hiding this comment.
The section underline for "Utilities" is one character shorter than the section title. To avoid any reStructuredText section parsing issues, make the underline length match the title length.
| -------- | |
| ---------- |
Description
The embodichain.agents.rl module API documentation was not displaying any
classes or functions. This fix adds explicit documentation for each RL
submodule so that Sphinx can properly generate the API reference.
Type of change
Checklist
black .command to format the code base.