EVO X
Open menu

Guía de Redacción de Documentos

Guía de Redacción de Documentos

Esta guía describe las mejores prácticas para redactar y mantener la documentación en todo el código base y los archivos complementarios.

Documentación en el Código (Docstrings)

Los docstrings son esenciales para comprender el propósito, el uso y el comportamiento de su código. Por favor, siga las siguientes convenciones:

Reglas Generales

  • Documente todas las clases, métodos y funciones públicas utilizando docstrings.
  • Utilice docstrings al estilo Sphinx.
  • No incluya tipos de parámetros en el docstring; se espera que se declaren en la firma de la función utilizando type hints.

Formato y Directivas

Utilice las siguientes directivas para describir diferentes elementos:

  • :param <name>: — Describe un parámetro.
  • :return: — Describe el valor de retorno.
  • :raises <exception>: — Describe las excepciones que la función podría lanzar.

Ejemplo

def add(a: int, b: int) -> int:
    """
    Add two integers.

    :param a: The first integer.
    :param b: The second integer.
    :return: The sum of the two integers.
    :raises ValueError: If either input is not an integer.
    """
    if not isinstance(a, int) or not isinstance(b, int):
        raise ValueError("Inputs must be integers.")
    return a + b

Documentación Externa (Directorio docs/)

Toda la documentación a nivel de proyecto se encuentra en el directorio docs/. Estos documentos sirven de apoyo tanto a usuarios como a desarrolladores, proporcionando guías, ejemplos y referencias.

Formato

  • Utilice Markdown (.md) o Jupyter Notebooks (.ipynb) para la documentación.
  • Se prefiere Markdown para el contenido narrativo y la documentación estática.
  • Utilice Jupyter Notebooks para contenido ejecutable e interactivo (por ejemplo, tutoriales o demostraciones).

Lineamientos para Jupyter Notebooks

  • Asegúrese de que todos los notebooks sean completamente ejecutables.
  • Siempre ejecute todas las celdas y guarde la salida antes de realizar el commit.
  • Nuestro entorno de CI/CD no admite la ejecución en GPU, por lo que los notebooks deben ejecutarse previamente de forma local.

Directivas de Markdown y Notebooks

Utilice los siguientes patrones para un formato enriquecido:

  • [name](#ref) — Referencia cruzada interna, por ejemplo, [ModuleBase](#evox.core.module.ModuleBase) o [ModuleBase](#ModuleBase)
  • ![Alt Text](path) — Incrustar imágenes, por ejemplo, ![Module base](/_static/modulebase.png)

Traducción

La documentación admite contenido multilingüe. Siga los pasos a continuación para actualizar o generar traducciones.

Actualización de Traducciones (por ejemplo, para zh_CN)

cd docs
make gettext
sphinx-intl update -p build/gettext -l zh_CN
cd ..
python docs/fix_output.py
← Volver a documentación