Add sphinx documentation #25
Merged
Conversation
This file contains 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
ribdp
force-pushed
the
add-sphinx-documentation
branch
2 times, most recently
from
af989d9 to
e05eaa5
Compare
ribdp
requested review from
SaikiranGudla,
jansunil and
CMinajigi
as code owners
|
Hi all, any comments here? |
jansunil
reviewed
Apr 4, 2024
| @@ -70,10 +70,16 @@ | |||
| all_props = [all_props,s]; | |||
| end | |||
| top_doc = help(dotmfilename); | |||
| disp("Hello") | |||
There was a problem hiding this comment.
What is the significance of this step?
There was a problem hiding this comment.
I think that was an older commit wherein I had added that line as a debug step. It's been removed in one of the subsequent commits.
The commit history is honestly not the cleanest. I'll squash the commits in the end before merging.
|
Hi @jansunil , @SaikiranGudla , @CMinajigi - any further comments? |
|
Just fyi, you can check out the built documentation here - https://analogdevicesinc.github.io/PrecisionToolbox/ |
jansunil
previously approved these changes
Apr 5, 2024
SaikiranGudla
previously approved these changes
Apr 5, 2024
1. Add sphinx conf and makefile 2. Add common files and images 3. Add script to generate rst files for projects and to add to index 4. Modify comments for driver classes to allow code documentation Signed-off-by: RibhuDP <[email protected]>
ribdp
force-pushed
the
add-sphinx-documentation
branch
from
e05eaa5 to
bee62a7
Compare
jansunil
approved these changes
Apr 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request Description
Migrate documentation from markdown and mkdocs, to rst and Sphinx
Add script to be run for code documentation
Update the documentation workflow to build the sphinx docs
PR Type
PR Checklist