[Doc] Integrating tutos in sphinx doc #651
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
facebook-github-bot
added
the
CLA Signed
vmoens
reviewed
Nov 7, 2022
Collaborator
vmoens
left a comment
vmoens
left a comment
There was a problem hiding this comment.
For some reason the rest of the doc has disappeared
With this PR:
What the doc looks like as of now
vmoens
changed the title
…& modifying knowledge_base.py to locally create python scripts for Sphinx documentation. Cleaned the tutorials/sphinx-tutorials repo and added a second script, tensordict.py
…y. Updated config and content_generation files to be able to use src scripts and the media information.
vmoens
changed the title
Bug fixes and syntax changes for: - docs/source/config.py - docs/source/content_generation.py - tutorials/sphinx-tutorials/multi_task.py - tutorials/sphinx-tutorials/tensordict.py - tutorials/sphinx-tutorials/tensordict_module.py - tutorials/sphinx-tutorials/torchrl_demo.py
Codecov Report
@@ Coverage Diff @@
## main #651 +/- ##
=======================================
Coverage 87.68% 87.68%
=======================================
Files 119 119
Lines 20022 20022
=======================================
Hits 17557 17557
Misses 2465 2465
Flags with carried forward coverage won't be shown. Click here to find out more.
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
added 2 commits
November 10, 2022 12:46
…rch_envs.py. Some bugs remain, they are to be fixed.
Author
|
Some bugs to look into:
|
1 task
1 task
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is the beginning of the creation of Pytorch RL documentation using Sphinx.
The config file was adapted to run the tutorial file within
tutorials/sphinx-tutorials/demos_source/.Running
pip install -r tutorials/sphinx-tutorials/requirements_doc.txtinstalls all packages to generate the documentation.This is a work in progress, and folder structure and other details will eventually change.
Motivation and Context
This is to re-write tutorial files from notebooks to python scripts.
Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax
close #15213if this solves the issue #15213Related to issue #628
Types of changes
What types of changes does your code introduce? Remove all that do not apply:
Checklist
Go over all the following points, and put an
xin all the boxes that apply.If you are unsure about any of these, don't hesitate to ask. We are here to help!