We can add categories into each tutorial, which allow the users to filter the tutorials
better search engine
new UI
order by
What changed with this
readthedocs.org/ didn't support 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 branch gh-pages)
to mitigate the breaking changes, I added a make setup and make setup-quarto to help installing the dependencies
This command just works for linux -- the quarto is a binary and not a python package! To setup it up into another OS please check out the quarto documentation.
The UI/theme isn't the same from the main docs -- but we update it to look like it
What has been done
[x] Minimal setup using Quarto
[x] Delete sphinx and myst-st configs files
[x] Initial configuration of Quarto (_quarto.yml)
[x] Index page: A temporary page in a "blog posts listing" style before #45 be done.
Should list our tutorials
Option for filtering, ordering and search
Tag!!! Be able to add categories "tags" into our tutorials, to be easy to navigate.
[x] Update the Makefile
Update the generate command to convert inplace the notebooks: Just to check if they are a valid jupyter notebook.
Update the execute command to execute inplace the notebooks.
Update the setup command
Added a setup-quarto: Which will works just on linux machine. This command directly download the binary of quar»
Update the command to after pip install the dependencies execute setup-quarto
Added 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!!
Added render command to build the webpages.
[x] Added a CI to deploy the quarto build into GH pages!
[x] Customize the theme to look like the main documentation (furo theme for sphinx)
[x] Add a basic front matter into each tutorial! And update the "open in colab" badge to be a HTML tag instead of the markdow»
[x] Add/generate a thumbnail and add it into the front matter for each tutorial!
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.