-
Notifications
You must be signed in to change notification settings - Fork 19
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
Add documentation support #114
Conversation
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.
Quick thoughts
Commit 2c7ae47 adds the CI, you can cherry-pick it |
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.
More thoughts
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.
A few comments on one part of the PR. More to follow
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.
Quick thought
22c1bc8
to
5ccf0e6
Compare
39a1f95
to
9cb8dd4
Compare
Deploys to github pages. Signed-off-by: Jorge Marques <[email protected]>
9cb8dd4
to
a7d78d9
Compare
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.
There are some empty pages that we'll have to fill out soon, but other than that, I'm happy with its current state
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.
A patch-review with minor changes to fixups warnings, remove trailing whitespace, among others.
Added the patch. |
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.
Thank you!
Remove trailing whitespace. Use new shell directive for bash code blocks. Rename testbenches_coding_guidelines to coding_guidelines because it is under testbenches already. On the templates, add the info to the write as reST comments, like: .. This is a comment Update ref- to external syntax. Update conf.py to reflect shell directive version requirement and fixup repository var value. Signed-off-by: Jorge Marques <[email protected]> Signed-off-by: Stanca Pop <[email protected]>
3a31a1b
to
3bcaca3
Compare
91c1eef
to
df863bb
Compare
Made the proposed changes.
Did some modifications afterwards.
Add documentation support for the testbenches repository.