[Feature Request][Doc] Enable doctest extension for Sphinx
Open
enhancement
- Dominant language
- Python
- Stars
- 3.6k
- Forks
- 484
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 207
Description
Motivation
The docs for TorchRL, and the docstrings from which they are built, contain many example snippets. Currently these snippets are only tested for correctness manually and on a fairly ad-hoc basis.
Solution
There is a sphinx extension called doctest which is able to run the snippets when building the docs to make sure there are no syntax errors. If we enable this in our CI pipelines we can be much more confident that examples in our documentation are syntactically correct and use up to date APIs.
Checklist
- I have checked that there is no similar issue in the repo (required)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.