Skip to content

Update RL module API docs#171

Merged
yuecideng merged 1 commit intomainfrom
yueci/update-rl-api-docs
Mar 10, 2026
Merged

Update RL module API docs#171
yuecideng merged 1 commit intomainfrom
yueci/update-rl-api-docs

Conversation

@yuecideng
Copy link
Contributor

@yuecideng yuecideng commented Mar 10, 2026

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

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation update

Checklist

  • I have run the black . command to format the code base.
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • Dependencies have been updated, if applicable.

Copilot AI review requested due to automatic review settings March 10, 2026 17:25
@yuecideng yuecideng added the docs Improvements or additions to documentation label Mar 10, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.agents page renders correctly.
  • Adds explicit .. automodule:: sections for embodichain.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
------------
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
------------
-------------

Copilot uses AI. Check for mistakes.
:show-inheritance:

Utilities
--------
Copy link

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
--------
----------

Copilot uses AI. Check for mistakes.
@yuecideng yuecideng merged commit 738c75f into main Mar 10, 2026
9 checks passed
@yuecideng yuecideng deleted the yueci/update-rl-api-docs branch March 10, 2026 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants