Switch to Quarto as website builder

[redeboer]

It starts to look like Quarto is a better alternative for this repository, because it is faster in building websites with a large number of pages.

Related issues

Beta Give feedback

1. Technical Reports overview is not a data table anymore #8
   🐛 Bug 📝 Docs +2
   
2. Implement per-page changelog with sphinx-git #9
   📝 Docs +1
   

[redeboer]

A test implementation is available at https://github.com/redeboer/compwa-reports/tree/quarto. You can run it with:

quarto preview docs

For now, I am inclined to stick with the Sphinx ecosystem.

Quarto

Advantages

• Blog post overview looks amazing, ideal for Technical Report overview
• Great support for listing metadata, like abstract, author, etc.
• Re-rendering is quite fast when saving
• More active (and larger?) community
• jupyterlab-quarto seems to be more actively maintained than jupyterlab-myst
• Easy to activate cookie preference buttons

Disadvantages

• No linkcheck
• Bad support for intersphinx
• Impossible to hide the input of specific cells
• Impossible to hide or remove cell output
• Code highlighting doesn't look too great
• Links and inline code doesn't look good in the default dark themes
• (?) Jupyter notebooks are overwritten with cell output when executed?
• TR overview (blog post listing) does not update when updating the metadata of a TR
• Community seems to be oriented more to R
• No support yet on Read the Docs

Sphinx ecosystem

Advantages

• Easily extendable and pluggable
• Good support for Jupyter notebooks
• No need to rewrite all the syntax

Disadvantages

• Builds are slow