valadoc org

Valadoc.org

Reste croquant, même dans le lait.

Ce package contient des outils de construction utilisés pour générer Valadoc.org et ne devrait idéalement pas être utilisé pour générer d'autres pages.

Bâtiment

Afin de construire les documents, vous aurez besoin de ce qui suit:

• valadoc > = 0,35.0
• php
• 4 Go d'espace libre

Sur le système d'exploitation élémentaire ou Ubuntu:

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

Arc ou dérivés fonctionnent:

pacman -S vala php

Ensuite, installez les dépendances JS:

npm install

Après l'installation de valadoc , vous pouvez passer à la construction de la documentation. Courez simplement:

make serve

Cela prendra un peu de temps, alors prenez-vous une tasse de café; Si vous êtes impatient, courez:

make serve-mini

pour une version de test minimale. Si vous rencontrez une erreur à cette étape, veuillez consulter la section des pièges communs. Une fois le bâtiment terminé, vous devriez voir un dossier valadoc.org .

Pour accéder à la documentation, naviguez sur votre navigateur vers http: // localhost: 7777.

Installer localement

Pour installer la documentation de Valadoc sous le nom de Devhelp Books, construisez d'abord les pages avec soit

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

pour juste Glib, Gio et Gobject, ou

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

pour tous les packages. Cela peut prendre un peu plus de temps.

Après ça, tu peux courir

sudo make install

Pour installer les livres Devhelp dans votre système. Maintenant, lancez Devhelp et utilisez-les!

Recherche

Pour une expérience plus complète, vous devrez installer Manticore et xsltproc .

Sur le système d'exploitation élémentaire ou Ubuntu:

sudo apt install xsltproc

Exécutez la commande suivante pour générer des index de recherche:

make serve-search

Cela (finalement!) Démarrera un démon de manticore sur le port 51413 .

Ajouter de nouveaux packages

Ouvrez documentation/packages.xml et ajoutez une nouvelle entrée de package.

Utilisez <external-package> pour créer des liens externes:

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

Utilisez <package> pour créer et inclure la documentation pour les fichiers VAPI:

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

Les attributs suivants sont pris en charge:

Nom	Description
nom	Le nom vapi
déprécié	Réglez-le sur "vrai" pour marquer un package comme obsolète
maintient	Liste des mainteneurs contraignants
girou	Le fichier gir utilisé pour extraire la documentation de
c-docs	Lien vers C Documentation
ignorer	Ne créez pas de documentation pour cette entrée
maison	Lien de page d'accueil
drapeaux	Flags Vala supplémentaires (dépendances manquantes, ...)
galerie	Lien vers une galerie de widget GTK-DOC
i-image-source	Source pour télécharger des images à partir de

Les fichiers gir et vapi référencés doivent faire partie de l'un des référentiels suivants:

• vala
• Vala-Girs
• vala-extra-vapis

Ajouter de nouveaux exemples de code source

Copiez vos exemples à examples/<vapi-name>/ et ajoutez une nouvelle entrée à 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 >

S'il s'agit du premier exemple pour le package, ajoutez une ligne à la cible check-examples de Makefile .

Ajouter une documentation manuscrite

Créez un nouveau fichier appelé <vapi-name>.valadoc dans documentation/<vapi-name>/ :

 ...

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

 ...

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

Aperçu de l'outil

• GÉNÉRATEUR: PARSES packages.xml Fichiers décrivant tous les packages. Il est responsable de la construction de la page. Il récupère des ressources telles que les images provenant de sources spécifiées, calcule les cals de valadoc, construit la documentation pour des packages spécifiés et met en forme toute la page. ( make serve , make serve-mini )
• Configgen: utilisé pour générer des fichiers de configuration pour notre index de recherche.
• Valadoc-Example-Gen: Utilisé en interne pour générer des exemples de listes.
• ValAdoc-Example-Tester: Compiles et vérifie tous les exemples enregistrés. ( make test-examples )

Pièges communs

Uncaught Error: Class 'mysqli' not found

• Extension find /etc -name php.ini non-comment extension=mysqli.so dans le php.ini de votre système

error: failed to load driver

• Votre version ValAdoc ne prend pas en charge la version Vala demandée. Installez une version Vala récente et recompilez Valadoc.
• Changer VALAC_VERSION dans MakeFile.

Autres erreurs:

• Vérifiez LOG à la racine de ce dépôt pour plus d'informations
• Avez-vous manqué d'espace disque?

Contacter et aider

• Page d'accueil, git
• Problème Tracker, valadoc.org
• Problème Tracker, Valadoc (maintenant une partie de Vala)
• IRC: irc.gome.org, #vala (Flo, UTC + 01: 00)
• Mail: [email protected]