Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions es.json
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@
"es/api-playground/mdx-setup",
"es/api-playground/asyncapi-setup",
"es/api-playground/graphql-setup",
"es/api-playground/sdk-reference-setup",
"es/api-playground/troubleshooting"
]
},
Expand Down
116 changes: 116 additions & 0 deletions es/api-playground/sdk-reference-setup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: "Configuración de referencias de SDK"
description: "Genera páginas de referencia de SDK a partir de tus herramientas de documentación existentes: TypeDoc, DocFX, Javadoc, Sphinx o phpDocumentor."
keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
---

Usa la propiedad de navegación `sdk` para generar páginas de referencia para tus bibliotecas de SDK a partir de las herramientas de documentación que ya utilizas. Mintlify lee el artefacto de compilación de cada herramienta y crea una página para cada clase, interfaz, módulo y función, con grupos de navegación, enlaces entre páginas e indexación de búsqueda incluidos.

<div id="supported-formats">
## Formatos compatibles
</div>

| `format` | Tool | Artifact |
| --- | --- | --- |
| `typedoc` | [TypeDoc](https://typedoc.org) (TypeScript/JavaScript) | Archivo de exportación JSON |
| `docfx` | [DocFX](https://dotnet.github.io/docfx/) (.NET) | Directorio de salida de `docfx metadata` (YAML de ManagedReference) |
| `javadoc` | [Javadoc](https://docs.oracle.com/en/java/javase/17/javadoc/javadoc.html) (Java) | Directorio HTML del doclet estándar |
| `sphinx` | [Sphinx](https://www.sphinx-doc.org) (Python) | Directorio de salida del builder JSON |
| `phpdoc` | [phpDocumentor](https://phpdoc.org) (PHP) | Archivo `structure.xml` |

<div id="generate-an-artifact">
## Generar un artefacto
</div>

Ejecuta tu herramienta de documentación con un formato de salida legible por máquina. Si ya publicas documentación generada desde CI, normalmente basta con cambiar un solo flag en el mismo comando.

<CodeGroup>

```bash TypeDoc
npx typedoc --json typedoc.json src/index.ts
```

```bash DocFX
docfx metadata docfx.json
```

```bash Javadoc
javadoc -d javadoc-output -sourcepath src/main/java -subpackages com.example
# O descarga el jar de javadoc publicado desde Maven Central
```

```bash Sphinx
python -m sphinx -b json docs/source artifacts/json
```

```bash phpDocumentor
phpdoc -d src -t artifacts --template=xml
```

</CodeGroup>

<div id="auto-populate-sdk-pages">
## Generar automáticamente páginas de SDK
</div>

Agrega una propiedad `sdk` a una pestaña en tu `docs.json`. Mintlify analiza el artefacto y crea grupos de navegación y páginas para la biblioteca.

```json
"navigation": {
"tabs": [
{
"tab": "SDK Reference",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",
"directory": "sdk/typescript"
}
}
]
}
```

<ResponseField name="format" type="string" required>
La herramienta de documentación que produjo el artefacto: `typedoc`, `docfx`, `javadoc`, `sphinx` o `phpdoc`.
</ResponseField>

<ResponseField name="source" type="string" required>
Ruta relativa al archivo o directorio del artefacto en tu repositorio de documentación, o una URL HTTPS.
</ResponseField>

<ResponseField name="directory" type="string">
El prefijo de la ruta URL para las páginas generadas. El valor predeterminado es `sdk-reference`.
</ResponseField>

Agrega varias pestañas para documentar varias bibliotecas. Cada pestaña necesita un `directory` único.

<Tip>
Agrega tu directorio de artefactos a [`.mintignore`](/es/organize/mintignore) para que Mintlify trate los artefactos como entradas de compilación en lugar de publicarlos como activos estáticos.
</Tip>

<div id="use-remote-sources">
## Usar fuentes remotas
</div>

Establece `source` como una URL HTTPS para obtener el artefacto en tiempo de compilación en lugar de incluirlo en tu repositorio de documentación.

Los formatos de archivo único (`typedoc`, `phpdoc`) aceptan una URL directa al archivo. Los formatos de directorio (`docfx`, `javadoc`, `sphinx`) aceptan un archivo zip. Los jars de Javadoc publicados en Maven Central funcionan sin necesidad de reempaquetarlos:

```json
{
"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"
}
}
```

Los artefactos remotos tienen un límite de descarga de 50 MB y un límite de tamaño extraído de 200 MB.

<div id="keep-references-up-to-date">
## Mantener las referencias actualizadas
</div>

Regenera el artefacto siempre que tu SDK cambie. Un patrón común es un trabajo de CI en cada repositorio de SDK que ejecuta la herramienta de documentación al publicar una nueva versión y luego confirma el artefacto en tu repositorio de documentación o lo sube a una URL estable a la que apunta `source`.
27 changes: 27 additions & 0 deletions es/organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,33 @@ Para obtener más información sobre cómo hacer referencia a endpoints de OpenA
```


<div id="sdk-references">
## Referencias de SDK
</div>

Genera páginas de referencia de SDK a partir de los artefactos de compilación de tus herramientas de documentación. Agrega una propiedad `sdk` a una pestaña con el `format` del artefacto (`typedoc`, `docfx`, `javadoc`, `sphinx` o `phpdoc`), una ruta `source` o URL HTTPS, y un `directory` opcional para el prefijo de URL de las páginas generadas.

Mintlify analiza el artefacto y genera grupos de navegación y páginas para cada clase, interfaz, módulo y función de la biblioteca.

Para obtener más información sobre cómo generar artefactos y configurar fuentes, consulta la [Configuración de referencias de SDK](/es/api-playground/sdk-reference-setup).

```json
{
"navigation": {
"tabs": [
{
"tab": "TypeScript SDK",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",
"directory": "sdk/typescript"
}
}
]
}
}
```

<div id="versions">
## Versiones
</div>
Expand Down
1 change: 1 addition & 0 deletions fr.json
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@
"fr/api-playground/mdx-setup",
"fr/api-playground/asyncapi-setup",
"fr/api-playground/graphql-setup",
"fr/api-playground/sdk-reference-setup",
"fr/api-playground/troubleshooting"
]
},
Expand Down
116 changes: 116 additions & 0 deletions fr/api-playground/sdk-reference-setup.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
---
title: "Configuration des références SDK"
description: "Générez des pages de référence SDK à partir de votre outillage de documentation existant : TypeDoc, DocFX, Javadoc, Sphinx ou phpDocumentor."
keywords: ["sdk", "typedoc", "docfx", "javadoc", "sphinx", "phpdocumentor", "reference"]
---

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.

<div id="supported-formats">
## Formats pris en charge
</div>

| `format` | Tool | Artifact |
| --- | --- | --- |
| `typedoc` | [TypeDoc](https://typedoc.org) (TypeScript/JavaScript) | Fichier d’export JSON |
| `docfx` | [DocFX](https://dotnet.github.io/docfx/) (.NET) | Répertoire de sortie de `docfx metadata` (YAML ManagedReference) |
| `javadoc` | [Javadoc](https://docs.oracle.com/en/java/javase/17/javadoc/javadoc.html) (Java) | Répertoire HTML du doclet standard |
| `sphinx` | [Sphinx](https://www.sphinx-doc.org) (Python) | Répertoire de sortie du builder JSON |
| `phpdoc` | [phpDocumentor](https://phpdoc.org) (PHP) | Fichier `structure.xml` |

<div id="generate-an-artifact">
## Générer un artefact
</div>

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.

<CodeGroup>

```bash TypeDoc
npx typedoc --json typedoc.json src/index.ts
```

```bash DocFX
docfx metadata docfx.json
```

```bash Javadoc
javadoc -d javadoc-output -sourcepath src/main/java -subpackages com.example
# Ou téléchargez le jar javadoc publié depuis Maven Central
```

```bash Sphinx
python -m sphinx -b json docs/source artifacts/json
```

```bash phpDocumentor
phpdoc -d src -t artifacts --template=xml
```

</CodeGroup>

<div id="auto-populate-sdk-pages">
## Remplir automatiquement les pages SDK
</div>

Ajoutez 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.

```json
"navigation": {
"tabs": [
{
"tab": "SDK Reference",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",
"directory": "sdk/typescript"
}
}
]
}
```

<ResponseField name="format" type="string" required>
L’outil de documentation qui a produit l’artefact : `typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`.
</ResponseField>

<ResponseField name="source" type="string" required>
Chemin relatif vers le fichier ou le répertoire de l’artefact dans votre dépôt de documentation, ou une URL HTTPS.
</ResponseField>

<ResponseField name="directory" type="string">
Le préfixe de chemin d’URL pour les pages générées. Par défaut, `sdk-reference`.
</ResponseField>

Ajoutez plusieurs onglets pour documenter plusieurs bibliothèques. Chaque onglet doit avoir un `directory` unique.

<Tip>
Ajoutez le répertoire de votre artefact à [`.mintignore`](/fr/organize/mintignore) afin que Mintlify traite les artefacts comme des entrées de build plutôt que de les publier comme des ressources statiques.
</Tip>

<div id="use-remote-sources">
## Utiliser des sources distantes
</div>

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 :

```json
{
"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.

<div id="keep-references-up-to-date">
## Maintenir les références à jour
</div>

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`.
27 changes: 27 additions & 0 deletions fr/organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -604,6 +604,33 @@ Pour plus d'informations sur la manière de référencer des endpoints OpenAPI d
```


<div id="sdk-references">
## Références SDK
</div>

Générez des pages de référence SDK à partir des artefacts de build de vos outils de documentation. Ajoutez une propriété `sdk` à un onglet avec le `format` de l’artefact (`typedoc`, `docfx`, `javadoc`, `sphinx` ou `phpdoc`), un chemin `source` ou une URL HTTPS, et un `directory` optionnel pour le préfixe d’URL des pages générées.

Mintlify analyse l’artefact et génère des groupes de navigation et des pages pour chaque classe, interface, module et fonction de la bibliothèque.

Pour plus d’informations sur la génération d’artefacts et la configuration des sources, consultez [Configuration des références SDK](/fr/api-playground/sdk-reference-setup).

```json
{
"navigation": {
"tabs": [
{
"tab": "TypeScript SDK",
"sdk": {
"format": "typedoc",
"source": "sdk-artifacts/typedoc.json",
"directory": "sdk/typescript"
}
}
]
}
}
```

<div id="versions">
## Versions
</div>
Expand Down
1 change: 1 addition & 0 deletions zh.json
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@
"zh/api-playground/mdx-setup",
"zh/api-playground/asyncapi-setup",
"zh/api-playground/graphql-setup",
"zh/api-playground/sdk-reference-setup",
"zh/api-playground/troubleshooting"
]
},
Expand Down
Loading