CI for building doxygen document and deploy to GitHub pages #5
Conversation
|
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... |
There was a problem hiding this comment.
- 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
letterpaper, nota4-- 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)
There was a problem hiding this comment.
mathjax has been enabled. However, it doesn't support introduction.md as the main page for the doxygen document. I added syntax example in the end of introduction.md
There was a problem hiding this comment.
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.
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.mdis configured to be the main page.To develop doc locally, run
sudo apt-get install doxygen graphviz -yto install doxygen. Then rundoxygenand opendocs/html/index.htmlin the browser.Currently, all codes are documented. There are options to hide codes or source files as needed, then only classes will be documented.