valadoc org

Valadoc.org

Bleibt knusprig, sogar in Milch.

Dieses Paket enthält Build-Tools, die zum Erzeugen von Valadoc.org verwendet werden, und sollte idealerweise nicht zur Erzeugung anderer Seiten verwendet werden.

Gebäude

Um die Dokumente zu erstellen, benötigen Sie Folgendes:

• valadoc > = 0,35,0
• php
• 4 GB Freiraum

Auf elementarem Betriebssystem oder Ubuntu Run:

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

Bogen- oder Derivate laufen:

pacman -S vala php

Installieren Sie als Nächstes JS -Abhängigkeiten:

npm install

Nachdem Sie valadoc installiert haben, können Sie die Dokumentation erstellen. Einfach rennen:

make serve

Dies wird ein bisschen Zeit dauern, also schnappen Sie sich eine Tasse Kaffee. Wenn Sie ungeduldig sind, rennen Sie:

make serve-mini

für eine minimale Testversion. Wenn Sie in diesem Schritt auf einen Fehler stoßen, finden Sie im Abschnitt Common Fallstricks. Nachdem Sie das Gebäude abgeschlossen haben, sollten Sie einen Ordner valadoc.org sehen.

Um auf die Dokumentation zuzugreifen, navigieren Sie in Ihrem Browser unter http: // localhost: 7777.

Lokal installieren

Um die Valadoc -Dokumentation als DevHelp -Bücher zu installieren, erstellen Sie zuerst die Seiten mit beiden

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

für nur glib, gio und gobject oder

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

Für alle Pakete. Dies kann etwas länger dauern.

Danach können Sie rennen

sudo make install

So installieren Sie die DevHelp -Bücher in Ihrem System. Starten Sie jetzt DevHelp und verwenden Sie sie!

Suche

Für eine vollständigere Erfahrung müssen Sie Manticore und xsltproc installieren.

Auf elementarem Betriebssystem oder Ubuntu Run:

sudo apt install xsltproc

Der folgende Befehl ausführen, um Suchindizes zu generieren:

make serve-search

Dies wird (irgendwann!) Ein Manticore -Daemon in Port 51413 beginnen.

Fügen Sie neue Pakete hinzu

Öffnen Sie documentation/packages.xml und fügen Sie einen neuen Paketeingang hinzu.

Verwenden Sie <external-package> , um externe Links zu erstellen:

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

Verwenden Sie <package> , um Dokumentation für VAPI -Dateien zu erstellen und hinzuzufügen:

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

Die folgenden Attribute werden unterstützt:

Name	Beschreibung
Name	Der VAPI -Name
veraltet	Stellen Sie es auf '"true"' ein, um ein veraltetes Paket zu markieren
Betreuer	Liste der Bindungsbindungspartner
gir	Die GIR -Datei, die zum Extrahieren von Dokumentationen aus
C-Docs	Link zur C -Dokumentation
ignorieren	Erstellen Sie keine Dokumentation für diesen Eintrag
heim	Homepage Link
Flaggen	Zusätzliche Vala -Flaggen (fehlende Abhängigkeiten, ...)
Galerie	Link zu einer GTK-Doc-Widget-Galerie
Vapi-Image-Source	Quelle zum Herunterladen von Bildern von

Referenzierte Gir- und Vapi-Files müssen Teil eines der folgenden Repositorys sein:

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

Fügen Sie neue Beispiele für den Quellcode hinzu

Kopieren Sie Ihre Beispiele in examples/<vapi-name>/ und fügen Sie einen neuen Eintrag zu 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 >

Wenn dies das erste Beispiel für das Paket ist, fügen Sie das check-examples -Ziel von Makefile eine Zeile hinzu.

Fügen Sie handgeschriebene Dokumentation hinzu

Erstellen Sie eine neue Datei namens <vapi-name>.valadoc in documentation/<vapi-name>/ :

 ...

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

 ...

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

Werkzeugübersicht

• Generator: Parse packages.xml -Dateien, die alle Pakete beschreiben. Es ist für den Aufbau der Seite verantwortlich. Es holt Ressourcen wie Bilder aus angegebenen Quellen ab, berechnet Valadoc-Anstände, erstellt Dokumentation für bestimmte Pakete und setzt die gesamte Seite zusammen. ( make serve , make serve-mini )
• Konfiggen: Wird verwendet, um Konfigurationsdateien für unseren Suchindex zu generieren.
• Valadoc-Example-Gen: Intern zur Generierung von Beispiellisten verwendet.
• Valadoc-Exampe-Tester: Kompiliert und überprüft alle registrierten Beispiele. ( make test-examples )

Häufige Fallstricke

Uncaught Error: Class 'mysqli' not found

• Conprent extension=mysqli.so in Ihrem Betriebssystem php.ini ( find /etc -name php.ini )

error: failed to load driver

• Ihre Valadoc -Version unterstützt die angeforderte Vala -Version nicht. Installieren Sie eine aktuelle VALA -Version und eine Neukompilierung von Valadoc.
• Ändern Sie VALAC_VERSION in Makefile.

Andere Fehler:

• Weitere Informationen finden Sie im LOG dieses Repo
• Haben Sie den Speicherplatz ausgelaufen?

Kontakt und Hilfe

• Homepage, Git
• Issue Tracker, Valadoc.org
• Ausgeben Tracker, Valadoc (jetzt Teil von Vala)
• IRC: irc.gnome.org, #vala (Flo, UTC+01: 00)
• Mail: [email protected]