RFC for using sphinx doctest #850
Conversation
facebook-github-bot
added
the
CLA Signed
mathiasburger
force-pushed
the
feature/sphinx_doctest
branch
2 times, most recently
from
c2558d2 to
4b4cbdf
Compare
| run: | | ||
| cd ./docs | ||
| pip3 install -r requirements.txt | ||
| make doctest |
There was a problem hiding this comment.
I would rather put this test into ci.yml. This _build_test_upload is the one we upload compiled binaries.
All PR will execute GHA in ci.yml.
There was a problem hiding this comment.
I have put it into ci.yml now.
mathiasburger
force-pushed
the
feature/sphinx_doctest
branch
from
4b4cbdf to
caadff9
Compare
ejguan
left a comment
ejguan
left a comment
There was a problem hiding this comment.
I think this PR looks good. Thank you! Since we have enabled the ci for doctest, we might need to fix all docstring in this PR.
…de to being tested
mathiasburger
force-pushed
the
feature/sphinx_doctest
branch
from
caadff9 to
dd7c980
Compare
If you say that this kind of setup is the way to move forward, I am happy to committing to do further migration of the docstrings. Maybe we can go package by package to keep the PRs manageable? The approach allows continuous migration and as a finalization we could then remove |
Agree. Thank you! |
|
@ejguan has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
ejguan
left a comment
ejguan
left a comment
There was a problem hiding this comment.
Thank you for this effort. LGTM!
4 participants
RFC for using sphinx doctest and continously migrating the doctest code to being tested
Fixes #848
Changes
docs/Makefilewith adoctesttargetsphinx.ext.doctestindocs/source/conf.pytorchdata/dataloader2/adapter.pydocteststep to the CI in.github/workflows/_build_test_upload.yml