pytorch / pytorch/rl

[Feature Request] Locally build documentation for API preview

Open
#287 1 comment 0 reactions 1 assignee View on GitHub

@vmoens is already working on this.

Since Jul 17, 2022.

Documentation
Dominant language
Python
Stars
3.6k
Forks
487
Avg merge
1d 1h
Merged PRs (30d)
207

Description

Motivation

To fully understand the API of torchrl, maybe it can be a temporal solution for users to build docs locally to review the API

Solution

A make doc command like cd docs && make html && cd _build/html && python3 -m http.server, a bit like functorch.

Checklist

  • I have checked that there is no similar issue in the repo (required)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.