Voor mijn serie blogs over Drupal documentatie en de Qt Assistant, wilde ik modulaire API documentatie krijgen. Alles - Drupal Core en alle geïnstalleerde modules - op de grote hoop gooien werd namelijk erg rommelig. Aan de andere kant, alles helemaal gescheiden is ook weer omslachtig. Ik had een hulpje nodig dat automatisch nieuwe modules ontdekt en de documentatie in elkaar zet voor me. Daarna alles bundelen in één Qt Help Collection met de nodige filters, zodat ik alles samen of elke module's documentatie apart kan bekijken en snel kan wisselen binnen één interface. En dat is DoxyAssist!

Met DoxyAssist kun je documentatie van elk groot softwareproject opsplitsen in modules. De documentatie voor elke module wordt apart gebouwd. Daarna, als je de Qt Assistant gebruikt en DoxyAssist jouw help collectie laat maken, bundelt het ook weer alle losse onderdelen van de documentatie. In de Assistant worden filters aangemaakt, zodat je eenvoudig kan selecteren welke documentatie je precies wilt zien.

Verder is het mogelijk om een enkel Doxygen configuratiebestand (Doxyfile) in te lezen en te gebruiken als template. Als submodules kleine variaties in deze instellingen nodig hebben, kunnen ze aangepast worden zonder aparte Doxyfiles voor elke module te maken. Je kunt de nodige instellingen in het DoxyAssist configuratiebestand zetten, en teamleden hun eigen basistemplate laten gebruiken zodat ze de documentatie naar eigen wens kunnen aanpassen.

Speciale ondersteuning voor Drupal is er ook, waardoor DoxyAssist automatisch alle modules en thema's van de community zoekt en de documentatie groepeert zoals jij wilt.

Hierbij presenteer ik versie 0.1, onder GPLv3 licentie. DoxyAssist vereist Python en eventueel PyQt4. Het komt met wat configuratievoorbeelden om je op weg te helpen.

Download hier

Source code @ Gitorious