Documentación#

Guía para contribuir a la documentación de Construbot.

Descripción general#

La documentación de Construbot utiliza Sphinx con reStructuredText (RST) y admite compilaciones bilingües (inglés/español).

Ubicación: /docs/

Documentación de construcción#

Crear documentos en inglés:

cd docs
make html
open _build/html/index.html

Crear documentos en español:

make html-es
open _build/html/es/index.html

Reconstrucción automática (vista previa en vivo):

make livehtml
# Opens http://127.0.0.1:8000

Redacción de documentación#

Sintaxis RST:

==============
Page Title
==============

Section
=======

Subsection
----------

**Bold text**
*Italic text*
``Code inline``

.. code-block:: python

   # Code block
   def example():
       pass

.. note::
   Admonition block

Campo de golf:

:doc:`other-page`
:doc:`/full/path/to/page`
`External link <https://example.com>`_

Referencias cruzadas:

See :doc:`../architecture/overview`
See :class:`construbot.proyectos.models.Contrato`

Estructura de la documentación#

docs/
├── index.rst (main entry point)
├── user-guide/
├── developer/
├── contributor/
├── reference/
└── _glossary/

Siga la estructura existente al agregar nuevas páginas.

Guía de estilo#

1. Claro y conciso

2. Ejemplos de código

Incluya ejemplos de código de trabajo.

3. Términos en español

Patrón de uso: «Contracts (Español: Contratos)»

4. Referencias cruzadas

Enlace a páginas relacionadas.

5. Formato consistente

Siga la estructura de página existente.

Flujo de trabajo de traducción#

Extraer cadenas:

cd docs
make gettext

Actualizar traducciones:

make update-translations

Editar archivos .po:

# Edit locale/es/LC_MESSAGES/*.po
nano locale/es/LC_MESSAGES/index.po

Construir versión en español:

make html-es

Ver también#