This PR uses sphinx-gallery to setup the documentation webpage for the new MLIR-based HeteroCL. A testing website has already been deployed on https://cornell-zhang.github.io/heterocl/, and the legacy tutorials are also added to the website to provide initial guidance. Later, we will need to update the documentation for the new version and redirect the url to our own website.
Two hightlights here:
Use a modern theme that is much cleaner and organized.
The tutorial scripts are made to be run before each deployment, which means the output of the website depicts the exact output what users will see in a real Linux environment.
For future development:
The CI script is set to deploy the website only when the PR is merged to the main branch, so make sure the changes have been validated in your local machine (using make html in the docs folder can see generate the document).
docs branch will be deleted after this PR is merged to the main branch. We should create a new branch and modify the docs in our own fork in the future.
This PR uses
sphinx-galleryto setup the documentation webpage for the new MLIR-based HeteroCL. A testing website has already been deployed on https://cornell-zhang.github.io/heterocl/, and the legacy tutorials are also added to the website to provide initial guidance. Later, we will need to update the documentation for the new version and redirect the url to our own website.Two hightlights here:
For future development:
make htmlin thedocsfolder can see generate the document).docsbranch will be deleted after this PR is merged to the main branch. We should create a new branch and modify the docs in our own fork in the future.