Skip to content

Add documentation #208

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

Merged

Conversation

ashwinvaidya17
Copy link
Contributor

@ashwinvaidya17 ashwinvaidya17 commented Oct 24, 2024

What does this PR do?

  • Add initial documentation generation scaffold. It sets-up the documentation build that combines C++ and Python docs

TODO

  • Add github actions file
  • Organise the documentation

To Test

doxygen Doxyfile 
cd docs
make html && python -m http.server -d build/html

Fixes # (issue)

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?

Sorry, something went wrong.

Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>

Verified

This commit was signed with the committer’s verified signature.
andersy005 Anderson Banihirwe
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
refactor
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
@ashwinvaidya17 ashwinvaidya17 marked this pull request as ready for review October 28, 2024 14:14
@sovrasov
Copy link
Member

sovrasov commented Oct 29, 2024

@ashwinvaidya17 thanks for the prompt PR! Could you fetch the latest master into your branch? Does the code style failure look reasonable, or we can think of changing the CI script?

@ashwinvaidya17
Copy link
Contributor Author

It flags the make.bat file. I didn't write it. It was autogenerated by sphinx. My next goal is to slowly add pre-commit checks across the repo.

@ashwinvaidya17 ashwinvaidya17 mentioned this pull request Oct 29, 2024
3 tasks
@sovrasov sovrasov requested a review from eugene123tw October 29, 2024 11:38
@sovrasov
Copy link
Member

@eugene123tw could you have a look at the docs update?

Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
Copy link
Contributor

@eugene123tw eugene123tw left a comment

Choose a reason for hiding this comment

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

@ashwinvaidya17 Thanks, Ashwin! I’ve added a few minor comments, but overall, it looks great! We can start building on and enhancing our documentation now 👍

Signed-off-by: Ashwin Vaidya <ashwinnitinvaidya@gmail.com>
@ashwinvaidya17 ashwinvaidya17 enabled auto-merge (squash) October 29, 2024 15:04
…; branch 'master' of github.com:openvinotoolkit/model_api into ashwin/add_docs
@ashwinvaidya17 ashwinvaidya17 merged commit d64d907 into open-edge-platform:master Oct 30, 2024
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants