Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RLlib] auto API reference pages: rllib/env package only. #20486

Merged
merged 7 commits into from
Nov 19, 2021

Conversation

sven1977
Copy link
Contributor

@sven1977 sven1977 commented Nov 17, 2021

Auto API reference pages overhaul: rllib/env package only.

Why are these changes needed?

Related issue number

Checks

  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Comment on lines 15 to 19
.. toctree::
:maxdepth: 2

env.rst
../../rllib-package-ref.rst .. TODO: Eventually, move all reference pages into this dir here (doc/source/rllib/package_ref/)
Copy link
Contributor

Choose a reason for hiding this comment

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

i don't think the bottom rendered properly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I'll check ...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@sven1977 sven1977 added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Nov 18, 2021
RLlib API Reference
===================

.. tip:: We'd love to hear your feedback on using RLlib - `ask your questions or give feedback at <https://discuss.ray.io>`_!
Copy link
Contributor

Choose a reason for hiding this comment

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

this part doesn't render properly btw

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great catch. href doesn't get rendered, of course. Fixed

@sven1977 sven1977 merged commit 9d5c4a9 into ray-project:master Nov 19, 2021
@sven1977 sven1977 deleted the docs_api_reference_pages_1 branch June 2, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants