valadoc org

Valadoc.org

Se queda crujiente, incluso en leche.

Este paquete contiene herramientas de construcción utilizadas para generar valadoc.org e idealmente no debe usarse para generar otras páginas.

Edificio

Para construir los documentos, necesitará lo siguiente:

• valadoc > = 0.35.0
• php
• 4 GB de espacio libre

En el sistema operativo Elementary o Ubuntu Run:

sudo add-apt-repository ppa:vala-team
sudo apt update
sudo apt install valac valadoc libvaladoc-dev unzip php php-curl

Arco o derivados corren:

pacman -S vala php

A continuación, instale Dependencias JS:

npm install

Después de que esté instalado valadoc , puede pasar a construir la documentación. Simplemente ejecute:

make serve

Esto tomará un poco de tiempo, así que toma una taza de café; Si eres impaciente, corre:

make serve-mini

para una versión de prueba mínima. Si encuentra un error en este paso, consulte la sección Common Thactfalls. Después de completar el edificio, debería ver una carpeta valadoc.org .

Para acceder a la documentación, navegue por su navegador a http: // localhost: 7777.

Instalar localmente

Para instalar la documentación de Valadoc como libros de devhelp, primero cree las páginas con cualquiera

make build-docs-mini build-data GENERATOR_OPTS=--skip-existing

Solo para Glib, Gio y Gobject, o

make build-docs build-data GENERATOR_OPTS=--skip-existing

para todos los paquetes. Esto puede tomar un poco más.

Después de eso puedes correr

sudo make install

Para instalar los libros Devhelp en su sistema. ¡Ahora inicia Devhelp y úsalos!

Búsqueda

Para una experiencia más completa, deberá instalar Manticore y xsltproc .

En el sistema operativo Elementary o Ubuntu Run:

sudo apt install xsltproc

Ejecutar el siguiente comando para generar índices de búsqueda:

make serve-search

Esto (¡eventualmente!) Comenzará un demonio Manticore en el puerto 51413 .

Agregar nuevos paquetes

Abra documentation/packages.xml y agregue una nueva entrada de paquete.

Use <external-package> para crear enlaces externos:

< external-package name = " package-name " link = " http://path/to/docs " >
  short description
</ external-package >

Utilice <package> para construir e incluir documentación para archivos VAPI:

< package name = " gdl-1.0 " >
  short description
</ package >

Se admiten los siguientes atributos:

Nombre	Descripción
nombre	El nombre de vapi
desapercibido	Establecerlo en '"verdadero"' para marcar un paquete como desaprobado
mantenedores	Lista de mantenedores vinculantes
cemento	El archivo gir utilizado para extraer documentación de
cdocs	Enlace a la documentación C
ignorar	No cree documentación para esta entrada
hogar	Enlace de página de inicio
banderas	Banderas de Vala adicionales (dependencias faltantes, ...)
galería	Enlace a una galería de widgets GTK-Doc
vapi-imagen	Fuente para descargar imágenes de

Gir y Vapi-Files referenciados deben ser parte de uno de los siguientes repositorios:

• Vala
• Vala-girs
• Vala-Extra-Vapis

Agregar nuevos ejemplos de código fuente

Copie sus ejemplos a examples/<vapi-name>/ y agregue una nueva entrada a examples/<vapi-name>/<vapi-name>.valadoc.examples :

< example >
  < title >Example Title</ title >
  < image >optional-screenshot.png</ image >
  < file >file-name-1.vala</ file >
  < file >file-name-2.vala</ file >
  < compile >valac file-name1.vala file-name-2.vala ...</ compile >
  < node >Associated.Symbol.name1</ node >
  < node >Associated.Symbol.name2</ node >
</ example >

Si este es el primer ejemplo del paquete, agregue una línea al objetivo de check-examples de Makefile .

Agregar documentación escrita a mano

Cree un nuevo archivo llamado <vapi-name>.valadoc en documentation/<vapi-name>/ ::

 ...

/**
 * My valadoc comment
 */
c::c_symbol_name

 ...

/**
 * My valadoc comment
 */
Vala.Symbol.Name

Descripción general de la herramienta

• Generador: archivos PAUSES packages.xml que describen todos los paquetes. Es responsable de construir la página. Obtiene recursos como imágenes de fuentes especificadas, calcula Valadoc-Calls, crea documentación para paquetes especificados y se pone en la página completa. ( make serve , make serve-mini )
• configGen: se usa para generar archivos de configuración para nuestro índice de búsqueda.
• Valadoc-Ejemplo-Gen: se usa internamente para generar listados de ejemplo.
• Valadoc-Ejemplo-Tester: compila y verifica todos los ejemplos registrados. ( make test-examples )

Dificultades comunes

Uncaught Error: Class 'mysqli' not found

• extension=mysqli.so en el php.ini de su sistema operativo ( find /etc -name php.ini )

error: failed to load driver

• Su versión de Valadoc no admite la versión VALA solicitada. Instale una versión de Vala reciente y vuelva a compilar Valadoc.
• Cambie VALAC_VERSION en Makefile.

Otros errores:

• Consulte LOG en la raíz de este repositorio para obtener más información
• ¿Te has quedado sin espacio en disco?

Contacto y ayuda

• Página de inicio, git
• Tracker de emisión, valadoc.org
• Tracker de emisión, Valadoc (ahora parte de Vala)
• IRC: irc.gnome.org, #vala (Flo, UTC+01: 00)
• Correo: [email protected]