https://github.com/openrlhf/openrlhf-docs
https://github.com/openrlhf/openrlhf-docs
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/openrlhf/openrlhf-docs
- Owner: OpenRLHF
- Created: 2024-07-03T02:31:38.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T12:08:34.000Z (over 1 year ago)
- Last Synced: 2024-10-19T16:18:34.565Z (over 1 year ago)
- Size: 73.2 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
OpenRLHF Documentation
=====================
This repository contains the Sphinx documentation for `OpenRLHF `_.
Build locally
-------------
.. code-block:: bash
python -m pip install -r docs/requirements.txt
make -C docs html
Then open ``docs/build/html/index.html`` in your browser.
Contributing
------------
- Edit sources under ``docs/source/`` (reStructuredText, ``.rst``).
- Keep pages **non-redundant**: prefer linking to the canonical page instead of copying long command blocks.