NanoMichael / MicroTeX

A dynamic, cross-platform, and embeddable LaTeX rendering library
MIT License
417 stars 69 forks source link

WIP: General Documentation #129

Open sp1ritCS opened 2 years ago

sp1ritCS commented 2 years ago

depends on #128

this adds all files required to build the µTeX documentation using Doxygen. It also ships a custom theme, heavily inspired by the theme gi-docgen uses by default (the docs for the GTK widget introduced in my other PR) and somewhat based upon doxygen-awesome. Mobile support is currently very broken tho.

the CI publishes documentation as artifacts, if you want to take a look at the current design.

sp1ritCS commented 2 years ago

So, I've implemented support for viewing pages on mobile and I've added a (WIP) page about CLM Fonts.

whats missing now is:

@NanoMichael could you maybe look into writing documentation for Flutter/Skia and the CLM file format (see the table in doc/fontdoc.h), as I don't have much experience with either of them

I don't quite know why, but the version of doxygen that the ubuntu CI ships with is too old and results in a broken search bar / broken nav on mobile. But that issue doesn't occur when building on my machine (doygen 1.9.4).

NanoMichael commented 2 years ago

could you maybe look into writing documentation for Flutter/Skia and the CLM file format (see the table in doc/fontdoc.h), as I don't have much experience with either of them

Sure, I'll fill out the CLM doc.

PikachuHy commented 2 years ago

QT5 Documentation

Of course, my pleasure