-
Notifications
You must be signed in to change notification settings - Fork 87
Documentation Restructurting #350
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
.vscode/settings.json
Outdated
| ], | ||
| "python.testing.unittestEnabled": false, | ||
| "python.testing.pytestEnabled": true | ||
| "python.testing.pytestEnabled": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need this change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It picked up my VSCode settings and I removed them, but I must have forgotten the ",". I can remove it, which makes it easier. Just let me know.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah let's remove changes to this file in this PR. Can follow up in a separate PR if needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removed!
jgerh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checked documentation restructuring - no changes.
Signed-off-by: Andrew Schilling <aschilling@nvidia.com>
|
The links in readme.md are not updated Line 30 in 8ca8f79
|
* Fixing documentation layout Signed-off-by: Andrew Schilling <aschilling@nvidia.com> * documentation.md Signed-off-by: Andrew Schilling <aschilling@nvidia.com> * Removing live-server Signed-off-by: Andrew Schilling <aschilling@nvidia.com> * Correctin .vscode Signed-off-by: Andrew Schilling <aschilling@nvidia.com> --------- Signed-off-by: Andrew Schilling <aschilling@nvidia.com> Signed-off-by: Zoey Zhang <zozhang@nvidia.com>
This MR moves the source Markdown files out of the source folder and directly into the docs folder to match the layout of other framework libraries. It also added a documentation.md to help users build and view documentation locally. I've also reviewed and converted notes into rendered notes and adjusted the TOC trees to a more suitable layout. Additional Sphinx extensions have been installed to help with UX/UI issues.
Adds two new Sphinx extensions: