Generate rich navigable HTML docs using Nunavut

Applications & Usage Nunavut
21

There’s quite a bit of code cleanup still needed, and a couple of features and fixes still need to be implemented, so I would wait a bit to actually review the code - at least until the weekend. I’ll update the preview today to include the new syntax highlighting and text formatting. If you’d like to take a glance at the code @scottdixon I’d definitely appreciate it, but just be warned that it’s all WIP, so it’s not very clean.

I’ll continue to post updates on progress as we get closer to merging this feature.

2 Likes
22

Update:

image
image1672×919 296 KB

image
image1121×920 137 KB

Search and sidebar work!

I think this should mostly do it for features. We should be ready to merge after a little bug-cleaning and code cleanup.

2 Likes
23

In case people have not been following, the HTML documentation has been merged into Nunavut.

HTML documentation can be generated and hosted on Nunaweb. For instance, here is the HTML documentation for the uavcan public regulated data types:
https://nunaweb.uavcan.org/api/storage/docs/uavcan/uavcan/index.html

To generate HTML documentation locally via Nunavut, use the --experimental-languages and --target-language html flags.

2 Likes
24

Fantastic work, by the way. Thank you, Vincent.

1 Like