Awesome GitHub RepositoriesDocumentation Generators

Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets. The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references. The tool covers a broad capability surface including multi-language API generation for

Appledoc est un générateur de documentation Objective-C et un générateur de sites statiques qui analyse les commentaires du code source pour créer des ensembles de documentation HTML structurés. Son objectif principal est de générer des guides de référence développeur professionnels qui adhèrent à la documentation officielle de style Apple. L'outil se distingue en s'intégrant directement dans le processus de compilation du projet via des scripts de phase de build automatisés, garantissant que les guides techniques sont mis à jour au fur et à mesure des changements de code. Il offre une personnalisation étendue via des modèles HTML et CSS externes, ainsi qu'un système de configuration de liste de propriétés pour gérer les paramètres globaux et la résolution dynamique des chemins au moment de l'exécution. Le projet couvre un large éventail de capacités, incluant l'analyse du code source pour extraire les signatures des membres de l'API et organiser les méthodes en sections structurées. Il dispose d'un référencement croisé automatique entre les classes et les protocoles, la possibilité d'importer du contenu statique externe ou du markdown dans l'index principal, et la génération d'ensembles de documentation indexés spécifiquement pour les environnements de développement intégrés. Le système inclut également des utilitaires pour publier des versions de documentation via des fichiers d'archive et mettre à jour des flux atom, ainsi que des outils de débogage pour vérifier l'état final résolu des paramètres de configuration.