CI for building doxygen document and deploy to GitHub pages

[WeileiZeng]

The page is up on https://qec-pages.github.io/dist-m4ri/index.html

The workflow will run upon push at branches main or doxy. README.md is configured to be the main page.

To develop doc locally, run sudo apt-get install doxygen graphviz -y to install doxygen. Then run doxygen and opendocs/html/index.html in the browser.

Currently, all codes are documented. There are options to hide codes or source files as needed, then only classes will be documented.

[LeonidPryadko]

Thanks! You can add me as a reviewer (near top-right corner). This way I get a message that I need to look at the code. Of course, I can just do it...

[LeonidPryadko]

• Can you please enable mathjax ? There are some equations, and also some code snippets which are supposed to be typed in \tt font but what comes out on my machine is, e.g., "(method=1)" (in a section title)
• Do you think it would be nice to have pdf output automatically generated?
• Let us have letter paper, not a4 -- letter can be printed on a4 paper w/o much trouble but not the other way.
• Somewhere early on, we need to put a reference to QDistRnd GAP package. Saying that it works with more general codes (CSS and F-linear stabilizer codes over an arbitrary field F), as opposed to binary CSS here, but only with an equivalent of method=2.
• Also, see additional items in documentation #3 : add reference to the JOSS paper on QDistRnd (I can update the text after the first bib file is created)

[WeileiZeng]

mathjax has been enabled. However, it doesn't support $single dollar sign$ but \f$ formula \f$. I didn't find a way to incorporate markdown and doxygen. So I made a copy introduction.md as the main page for the doxygen document. I added syntax example in the end of introduction.md

[WeileiZeng]

For the pdf output, I don't think it is good to update pdf frequently in a git repo. Meanwhile, more CI workflow will easily get broken in the long run and become hard to maintain. I would suggest build pdf locally and upload to the release page only when necessary.