notes.org

Notes:

Building

builing the HTML requires the following python packages:

• sphinx
• clang
• hawkmoth
• m2r
• m2r2

We need to run the following couple of commands before the eventual html should be made:

• script to generate all the binary_c commands and explanations
• script to generate all the binarycpython grid commands and explanations

info

https://stackoverflow.com/questions/20059953/linking-to-source-code-file-in-sphinx https://stackoverflow.com/questions/39534718/how-to-create-a-pdf-out-of-sphinx-documentation-tool

Todo:

Write script to automatically rebuild the whole bunch

use typing from mypy and build that into the docs

https://github.com/seqan/seqan3-doc/blob/user/source/make_source.py https://www.pythonforthelab.com/blog/documenting-with-sphinx-and-readthedocs/

Hijack the make command to add some extra documents