Changes between Version 22 and Version 23 of Documentatie/Beheerder

Timestamp:

Mar 31, 2009 4:29:55 PM (17 years ago)

Author:

henk

Comment:

Informatie over het genereren van de online documenatie.

Documentatie/Beheerder

@@ -754 +754 @@
  * Upload het bestand naar '''Downloads''' op de TRAC site 
  * Pas de links aan op de wiki-homepage en in de installatiehandleiding, zodat deze wijzen naar de meest recente starter kit. 
+
+== Online documentatie genereren ==
+
+=== Infrastructuur en werking ===
+
+De benodigdheden voor het genereren van de online documentatie staan op de server in de directory '''/usr/local/apache1/openac-documentatie'''. Deze directory bevat de volgende onderdelen:
+||svn-checkout||een lokaal uitgecheckte versie van OpenAC||
+||genereer||een symbolische link naar het script waarmee de documentatie gegenereerd kan worden||
+||html||de html-output na het genereren van de documentatie||
+
+Het script gebruikt de volgende onderdelen uit de sandbox map van de OpenAC repository:
+||Doxyfile||het configuratiebestand van Doxygen||
+||doxypy.py||een doxygen filter voor het verwerken van Python-bestanden||
+||documentatie/custom||custom headers, footers, stylesheets e.d. die gebruikt worden door Doxygen tijdens het genereren van de documentatie||
+
+Het script begint met het bijwerken van de lokaal uitgecheckte versie van OpenAC met svn update. Vervolgens wordt de documentatie gegenereerd met Doxygen. Daarna wordt de documentatie naar de uiteindelijke locaties gekopieerd, te weten:
+||/usr/local/apache1/openac-site/documentatie/html||de documentatie||
+||/usr/local/apache1/openac-site/documentatie/custom||stylesheets e.d.||
+
+=== Genereren documentatie ===
+
+De online documentatie kan worden gegenereerd met het commando '''genereer''', op de volgende manier:
+
+{{{
+cd /usr/local/apache1/openac-documentatie
+./genereer
+}}}
+
+'''genereer''' is een symbolische link naar het script /usr/local/apache-1/openac-documentatie/svn_checkout/bin/documentatie en verandert dus automatisch al bin/documentatie wordt gewijzigd en gecommit. Na de wijziging is het natuurlijk wel noodzakelijk om een svn update te doen in de map svn_checkout.
+
+=== Afhankelijkheden ===
+
+Voor het genereren van de online documentatie moeten de volgende twee pakketten op de server zijn geinstalleerd:
+ * Graphviz, voor het dynamisch genereren van diagrammen door Doxygen;
+ * Doxygen, en wel de door ons zelf gewijzigde versie.
+
+Beide pakketten staan in /usr/local/inst
+
+Het configure script van Graphviz moet argument --enable-python=no meekrijgen, omdat er anders een compileerfout optreedt tijdens het compileren van de Python binding (?). Dus:
+
+{{{
+./configure --enable-python=no
+}}}