Files
2023-12-07 20:47:44 +01:00

4.8 KiB

Traducción Automática de Documentación de OpenAI

en| zh-Hans | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | fa | ro | sv | hu | cs | el | da | fi | he | no | hi | zh_tw | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat

Esta documentación ha sido traducida automáticamente y puede contener errores. No dudes en abrir una Pull Request para sugerir cambios.

Instalación

La herramienta se puede instalar a través de NPM:

    npm install -g autotranslatedoc

Asegúrese de configurar las variables de entorno: GITHUB_PERSONAL_ACCESS_TOKEN y OPENAI_API_KEY. Alternativamente, estos tokens se pueden pasar como parámetros. Consulte la documentación de GitHub para obtener un GITHUB_PERSONAL_ACCESS_TOKEN.

Uso

Página de Ayuda

Accede a la página de ayuda con el siguiente comando:

 autotranslatedoc -h

Traducción de Documentación

Autotranslatedoc toma 3 argumentos y muchas opciones

    autotranslatedoc <comando> <repo_org> <repo_name> (opciones)
  • comando puede ser: translate (para traducir), update (para actualizar una traducción), build (para construir una traducción)
  • repo_org es la organización del repositorio objetivo en GitHub
  • repo_name es el nombre del repositorio objetivo en GitHub

Las principales opciones disponibles son:

  • --language <lang_1>(, <lang_2>)* (o -l) para seleccionar el idioma al que desea traducir.
  • --docPath </url/path> (o -d) para limitar la traducción a archivos en una ruta específica.
  • --savePath <./localPath> (o -s) para seleccionar el directorio donde se guardará el archivo de guardado (por defecto es ./save).
  • --outputPath <./localPath> (o -o) al usar build, para especificar dónde se guardarán los archivos de documentación traducidos (por defecto es ./build)

Para traducir la documentación de un repositorio objetivo al francés y al español, use:

    autotranslatedoc translate run-llama llama_index -l fr,es

Este comando crea un archivo llama_index.json en el directorio run-lama del directorio de salida especificado (el valor predeterminado es ./save).

    ls ./save
        run-llama
            llama_index.json 

El archivo de guardado contiene todas las traducciones y se puede utilizar para generar la documentación en un formato objetivo (actualmente solo .md).

Para construir la documentación traducida, use:

    autotranslatedoc build run-llama llama_index -l fr,es

Este comando genera los directorios fr y es en el buildPath (por defecto es ./build) que contienen los archivos de documentación traducidos.

Para actualizar la documentación traducida en función de los cambios en los archivos originales, use:

    autotranslatedoc update run-llama llama_index -l fr,es

Para revisar la documentación a través de un servidor (función experimental), use:

    autotranslatedoc serve run-llama llama_index

Traducción de Documentación de Docusaurus

Para traducir documentación alojada en Docusaurus, utiliza:

    autotranslatedoc translate run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
    autotranslatedoc build run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus

Traducción solo del archivo README.md

Para traducir solo el archivo README, utiliza el modo readme:

    autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l fr,es -m readme

Traducción a todos los idiomas admitidos

Para traducir a todos los idiomas admitidos, utiliza la opción -l all:

    autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
    autotranslatedoc build run-llama LlamaIndexTS  -l all -m readme

Problemas Conocidos

Actualmente, la traducción con -all solo es compatible desde el inglés a todos los demás idiomas.