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

docs: add example notebooks into documentation pages #172

Merged
merged 14 commits into from
Oct 25, 2024

Conversation

CalMacCQ
Copy link
Contributor

@CalMacCQ CalMacCQ commented Oct 24, 2024

Description

Adding the notebook examples into the docs html pages. The coversion to html is done by the MyST-NB library. I'm avoiding execution for now. To show the cell outputs would require setting up GPUs in C.I. in the repository that builds the website or somehow executing them in this repository and just deploying the html from the website repository.

Screenshot 2024-10-25 at 13 07 07

remaining TODOs

Related issues

closes #154

Checklist

  • I have performed a self-review of my code.
  • I have commented hard-to-understand parts of my code.
  • I have made corresponding changes to the public API documentation.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have updated the changelog with any user-facing changes.

@CalMacCQ CalMacCQ marked this pull request as ready for review October 25, 2024 12:08
Copy link
Collaborator

@PabloAndresCQ PabloAndresCQ left a comment

Choose a reason for hiding this comment

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

Looks great and works locally (as long as the root folder is named pytket-cutensornet :P)

@CalMacCQ CalMacCQ merged commit 4ac5713 into main Oct 25, 2024
10 checks passed
@CalMacCQ CalMacCQ deleted the docs/html_notebooks branch October 25, 2024 14:39
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.

Add example notebooks to docs html pages
2 participants