Configuration des références SDK
Générez des pages de référence SDK à partir de votre outillage de documentation existant : TypeDoc, DocFX, Javadoc, Sphinx ou phpDocumentor.
Utilisez la propriété de navigation sdk pour générer des pages de référence pour vos bibliothèques SDK à partir des outils de documentation que vous exécutez déjà. Mintlify lit l’artefact de build de chaque outil et crée une page pour chaque classe, interface, module et fonction, avec les groupes de navigation, les liens entre les pages et l’indexation pour la recherche inclus.
format | Tool | Artifact |
|---|---|---|
typedoc | TypeDoc (TypeScript/JavaScript) | Fichier d’export JSON |
docfx | DocFX (.NET) | Répertoire de sortie de docfx metadata (YAML ManagedReference) |
javadoc | Javadoc (Java) | Répertoire HTML du doclet standard |
sphinx | Sphinx (Python) | Répertoire de sortie du builder JSON |
phpdoc | phpDocumentor (PHP) | Fichier structure.xml |
Exécutez votre outil de documentation avec un format de sortie lisible par machine. Si vous publiez déjà des docs générées depuis votre CI, il s’agit généralement de l’ajout d’un seul flag à la même commande.
npx typedoc --json typedoc.json src/index.tsAjoutez une propriété sdk à un onglet dans votre docs.json. Mintlify analyse l’artefact et crée des groupes de navigation et des pages pour la bibliothèque.
"navigation": {
"tabs": [
{
"tab": "SDK Reference",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",
"directory": "sdk/typescript"
}
}
]
}Vous devez déclarer sdk sur un onglet. Un onglet avec sdk peut inclure groups, mais aucune autre structure de navigation, telle que pages, versions ou languages. Il ne peut pas non plus inclure une propriété openapi, asyncapi ou graphql.
formatstringrequiredL’outil de documentation qui a produit l’artefact : typedoc, docfx, javadoc, sphinx ou phpdoc.
sourcestringrequiredChemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS. N’accepte pas les URL HTTP.
directorystringLe préfixe de chemin d’URL pour les pages générées. Par défaut, sdk-reference.
Ajoutez plusieurs onglets pour documenter plusieurs bibliothèques. Utilisez un directory unique pour chaque bibliothèque afin d’éviter les collisions de routes.
Ajoutez le répertoire de votre artefact à .mintignore afin que Mintlify traite les artefacts comme des entrées de build plutôt que de les publier comme des ressources statiques.
Mintlify ajoute les groupes de navigation générés après les éventuels groups de l’onglet. Les groupes varient selon le format et peuvent représenter des modules, des packages, des espaces de noms ou des types de symboles.
Chaque page générée documente une classe, une interface, une fonction, un type ou un autre symbole de l’artefact et renvoie vers les pages générées associées. Si un convertisseur produit des pages qui n’appartiennent à aucun groupe, Mintlify les regroupe sous un groupe Reference.
Définissez source sur une URL HTTPS pour récupérer l’artefact au moment du build au lieu de le committer dans votre dépôt de documentation.
Les formats à fichier unique (typedoc, phpdoc) acceptent une URL de fichier directe. Les formats à répertoire (docfx, javadoc, sphinx) acceptent une archive zip. Les jars Javadoc publiés sur Maven Central fonctionnent sans reconditionnement :
{
"tab": "Java SDK",
"sdk": {
"format": "javadoc",
"source": "https://repo1.maven.org/maven2/com/example/my-library/1.0.0/my-library-1.0.0-javadoc.jar",
"directory": "sdk/java"
}
}Les artefacts distants ont une limite de téléchargement de 50 Mo et une limite de taille extraite de 200 Mo.
Régénérez l’artefact chaque fois que votre SDK change. Un pattern courant est un job CI dans chaque dépôt de SDK qui exécute l’outil de documentation à chaque publication et, soit commite l’artefact dans votre dépôt de documentation, soit le téléverse vers une URL stable référencée par source.