Skip to content
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

Merged
merged 6 commits into from
Oct 30, 2024
Merged

Add documentation support #114

merged 6 commits into from
Oct 30, 2024

Conversation

StancaPop
Copy link
Collaborator

Add documentation support for the testbenches repository.

@StancaPop StancaPop requested a review from gastmaier July 23, 2024 11:46
Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick thoughts

docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/library/IPs/template_ip/index.rst Outdated Show resolved Hide resolved
docs/library/index.rst Outdated Show resolved Hide resolved
docs/user_guide/releases.rst Outdated Show resolved Hide resolved
@gastmaier
Copy link
Contributor

Commit 2c7ae47 adds the CI, you can cherry-pick it

Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More thoughts

docs/index.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/user_guide/index.rst Outdated Show resolved Hide resolved
docs/user_guide/introduction.rst Outdated Show resolved Hide resolved
docs/user_guide/git_repository.rst Show resolved Hide resolved
docs/user_guide/releases.rst Outdated Show resolved Hide resolved
docs/user_guide/build_tb.rst Show resolved Hide resolved
docs/user_guide/architecture.rst Outdated Show resolved Hide resolved
Copy link

@IuliaCMoldovan IuliaCMoldovan left a 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

docs/library/IPs/index.rst Outdated Show resolved Hide resolved
docs/library/IPs/template_ip/index.rst Outdated Show resolved Hide resolved
docs/library/xilinx/clk_vip/index.rst Outdated Show resolved Hide resolved
docs/library/IPs/template_ip/index.rst Outdated Show resolved Hide resolved
docs/library/IPs/template_ip/index.rst Outdated Show resolved Hide resolved
docs/library/frameworks/template_framework/index.rst Outdated Show resolved Hide resolved
docs/library/frameworks/template_framework/index.rst Outdated Show resolved Hide resolved
docs/library/index.rst Outdated Show resolved Hide resolved
docs/library/xilinx/clk_vip/index.rst Outdated Show resolved Hide resolved
docs/library/xilinx/clk_vip/index.rst Outdated Show resolved Hide resolved
@IstvanZsSzekely IstvanZsSzekely added the documentation Improvements or additions to documentation label Aug 6, 2024
Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quick thought

docs/user_guide/hdl_coding_guidelines.rst Outdated Show resolved Hide resolved
@StancaPop StancaPop force-pushed the add_doc_support branch 2 times, most recently from 39a1f95 to 9cb8dd4 Compare October 2, 2024 11:22
@StancaPop StancaPop marked this pull request as ready for review October 2, 2024 11:26
StancaPop and others added 2 commits October 2, 2024 15:46
Deploys to github pages.

Signed-off-by: Jorge Marques <[email protected]>
docs/user_guide/index.rst Outdated Show resolved Hide resolved
docs/user_guide/introduction.rst Outdated Show resolved Hide resolved
docs/user_guide/git_repository.rst Outdated Show resolved Hide resolved
docs/user_guide/build_tb.rst Outdated Show resolved Hide resolved
docs/user_guide/build_tb.rst Outdated Show resolved Hide resolved
docs/library/index.rst Outdated Show resolved Hide resolved
docs/projects/index.rst Outdated Show resolved Hide resolved
docs/projects/project_based/template/index.rst Outdated Show resolved Hide resolved
docs/projects/project_based/template/index.rst Outdated Show resolved Hide resolved
docs/projects/project_based/template/index.rst Outdated Show resolved Hide resolved
docs/user_guide/introduction.rst Outdated Show resolved Hide resolved
docs/user_guide/git_repository.rst Outdated Show resolved Hide resolved
docs/user_guide/build_tb.rst Outdated Show resolved Hide resolved
docs/projects/project_based/template/index.rst Outdated Show resolved Hide resolved
@IstvanZsSzekely IstvanZsSzekely mentioned this pull request Oct 8, 2024
Copy link
Contributor

@IstvanZsSzekely IstvanZsSzekely left a 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

Copy link
Contributor

@gastmaier gastmaier left a 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.

0001-Review-Testbeches-doc.patch

@StancaPop
Copy link
Collaborator Author

A patch-review with minor changes to fixups warnings, remove trailing whitespace, among others.

0001-Review-Testbeches-doc.patch

Added the patch.

gastmaier
gastmaier previously approved these changes Oct 14, 2024
Copy link
Contributor

@gastmaier gastmaier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

StancaPop and others added 3 commits October 21, 2024 08:32
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]>
docs/user_guide/introduction.rst Outdated Show resolved Hide resolved
docs/user_guide/architecture.rst Show resolved Hide resolved
@StancaPop StancaPop dismissed stale reviews from IstvanZsSzekely and IuliaCMoldovan October 25, 2024 08:53

Made the proposed changes.

@StancaPop StancaPop dismissed gastmaier’s stale review October 25, 2024 08:56

Did some modifications afterwards.

@StancaPop StancaPop merged commit 27b9971 into main Oct 30, 2024
2 checks passed
@StancaPop StancaPop deleted the add_doc_support branch October 30, 2024 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants