3 dépôts
Configures documentation generation to link dependencies to external sources.
Distinct from Documentation Generators: Distinct from Documentation Generators: focuses on cross-referencing external documentation rather than generating local site content.
Explore 3 awesome GitHub repositories matching development tools & productivity · External Documentation Linkers. Refine with filters or upvote what's useful.
Cargo is the official build system and package manager for the Rust programming language. It provides a unified command-line interface that orchestrates the entire development lifecycle, including compiling source code, managing complex dependency graphs, running tests, and distributing packages through a centralized registry. By utilizing declarative manifest files, it ensures that builds remain reproducible and consistent across different environments. The tool distinguishes itself through its deep integration with the Rust compiler and its sophisticated approach to project management. It f
Ensures consistent cross-referencing by linking dependencies to external documentation sources.
Ce projet est un framework complet pour la programmation lettrée qui permet aux développeurs de construire des bibliothèques Python prêtes pour la production entièrement au sein de Jupyter Notebooks. En traitant les notebooks comme la source de vérité principale, il intègre le code, la documentation et les tests dans un pipeline de développement unifié qui s'exporte directement vers des modules Python standard. Le framework se distingue par des outils spécialisés conçus pour surmonter les défis inhérents à l'utilisation de notebooks dans l'ingénierie logicielle professionnelle. Il inclut des hooks Git personnalisés et des pilotes de fusion qui assainissent les métadonnées volatiles des notebooks, éliminant efficacement les diffs bruyants et résolvant les conflits de fusion. De plus, il utilise des directives basées sur les cellules pour contrôler la visibilité du code, les tests et la génération de documentation, permettant aux développeurs de maintenir un code source propre et modulaire tout en travaillant dans un environnement interactif. Au-delà de son flux de travail de développement principal, le projet fournit une suite robuste d'outils d'automatisation pour l'ensemble du cycle de vie logiciel. Cela inclut un moteur de site statique pour rendre une documentation de qualité publication avec prise en charge des équations mathématiques et du référencement croisé des symboles, ainsi que des utilitaires pour gérer les dépendances du projet, le versionnage et les tests automatisés. Il prend également en charge les flux de travail d'intégration continue pour déployer la documentation et publier des paquets vers des registres standard. Le projet fournit un processus d'amorçage standardisé pour initialiser de nouveaux dépôts avec des pipelines pré-configurés pour les tests, la documentation et le contrôle de version.
Enables cross-referencing by indexing external documentation inventories to link symbols across projects.
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.
Connects source code comments and template documents to external files using name matching or standard syntax.