Task list

Go to Setup Sphinx to start editing the HB using Sphinx. For example, installing sphinx.

TODO

1. Add multiline (i.e. for overloaded functions listed consecutively)

#. Fix doc extraction: currently having problems, probably because refs and inline code … are not parsed correctly for transfer. Can drop conversion possibility if needed?

#. Check longer signatures and various ops (magma lang section for good variance, started with vertex+edge sets). One problem type is `&[..]`.

#. TOCs within sections: originally dropdowns. Can we do it? I tried but seems annoying

#. Chapter TOC: Rearrange? Related: change internal links to something for like original bold and hover grey?

1. Add intersphinx?

#. Check bib works for citing in different bibliographies (might need to use keyprefix)

1. bib does not parse $$. Fix

2. Github pages Setup

#. Add author page (originally automated), ackn page (web-content where?) and overview/info pages?

1. Doctest. Syntax for test extraction from examples.

2. Integration with session helper

3. Start checking other outputs (latex etc.)?

4. Clean up code.

Notes

1. Theme: Do not know what is most important, but I like the navigation of alabaster. Book is the closest I could find after a bit of looking.

2. Add any further extensions?