Migrate tutorial to use the quarto framework #63
Merged
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.
This PR aims to move the kornia tutorials to use the quarto framework instead of sphinx to generate the tutorials webpage.
You can check out this change on the deployed version on my gh page: https://johnnv1.github.io/tutorials/
Improvements
What changed with this
quarto
so, we will need to move to use GitHub pages (TODO: need to configure the kornia/tutorials to publish the gh-pages from the branchgh-pages
)make setup
andmake setup-quarto
to help installing the dependenciesWhat has been done
sphinx
andmyst-st
configs files_quarto.yml
)generate
command to convert inplace the notebooks: Just to check if they are a valid jupyter notebook.execute
command to execute inplace the notebooks.setup
commandsetup-quarto
: Which will works just on linux machine. This command directly download the binary of quar»setup-quarto
preview
command to execute the quarto preview to test locally the webpages. Use this command to develop locally it's easily to debug with it!!render
command to build the webpages.