search

LumaPictures / maya-to-hydra

This repo is no longer updated. Please see https://github.com/Autodesk/maya-usd
Other
10 stars 3 forks source link

Setup documentation engine for Maya to Hydra #52

Closed sirpalee closed 5 years ago

sirpalee commented 5 years ago

As the open-source release is getting closer and closer, we should set up an initial documentation engine, and generate a nice and fancy website.

After a bit of digging around Hyde looks like a good option. It can work together with Jekyll and generate out-of-source documentation. In the long term that seems like a better option compared to in-source documentation (like doxygen), since it doesn't clutter the source.

Their example site looks great, but I want to figure out if we can have some sort of a search functionality (the example lacks anything like that). I think Jekyll should be able to generate a site that supports fuzzy searching of classes/functions etc.

sirpalee commented 5 years ago

We should also consider doxygen, just because it's used by USD already.