Skip to content
Browse files

Added Docblox and Docbook tools and scripts

  • Loading branch information...
1 parent 24c67ce commit 947a88e27f09e9438c88522ab4f151970a861120 Michael committed Sep 10, 2011
Showing with 78 additions and 0 deletions.
  1. +30 −0 data/cookbooks/php/recipes/pear.rb
  2. +30 −0 docs/INSTALL.txt
  3. +3 −0 docs/create-dev.php
  4. +2 −0 docs/create-manual.php
  5. +13 −0 docs/manual/source.xml
View
30 data/cookbooks/php/recipes/pear.rb
@@ -46,11 +46,33 @@
action :discover
end
+php_pear_channel "pear.michelf.com" do
+ action :discover
+end
+
# using apt
package "phpunit" do
action :install
end
+# XSL needed by DocBlox
+package "php5-xsl" do
+ action :install
+end
+
+# Graphviz needed by DocBlox
+package "graphviz" do
+ action :install
+end
+
+# Sqlite needed by PHD (Docbook)
+package "php5-sqlite" do
+ action :install
+end
+
+
+# Using PEAR installer
+
execute "PEAR: upgrade all packages" do
command "pear upgrade-all"
end
@@ -77,4 +99,12 @@
execute "PEAR: install phpcpd" do
command "pear install -f phpunit/phpcpd"
+end
+
+execute "PEAR: install docblox" do
+ command "pear install -f docblox/DocBlox"
+end
+
+execute "PEAR: install phd" do
+ command "pear install -f --alldeps doc.php.net/phd"
end
View
30 docs/INSTALL.txt
@@ -0,0 +1,30 @@
+README
+======
+
+This directory should be used to place project specfic documentation including
+but not limited to project notes, generated API/phpdoc documentation, or
+manual files generated or hand written. Ideally, this directory would remain
+in your development environment only and should not be deployed with your
+application to it's final production location.
+
+
+Setting Up Your VHOST
+=====================
+
+The following is a sample VHOST you might want to consider for your project.
+
+<VirtualHost *:80>
+ DocumentRoot "C:/xampp/htdocs/doctrine2/public"
+ ServerName .local
+
+ # This should be omitted in the production environment
+ SetEnv APPLICATION_ENV development
+
+ <Directory "C:/xampp/htdocs/doctrine2/public">
+ Options Indexes MultiViews FollowSymLinks
+ AllowOverride All
+ Order allow,deny
+ Allow from all
+ </Directory>
+
+</VirtualHost>
View
3 docs/create-dev.php
@@ -0,0 +1,3 @@
+<?php
+echo shell_exec("docblox run -d ../application,../library/App -t dev");
+
View
2 docs/create-manual.php
@@ -0,0 +1,2 @@
+<?php
+echo shell_exec("phd --docbook manual/source.xml -o manual/html/");
View
13 docs/manual/source.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+ <book xml:id="myapp_users_manual" xmlns="http://docbook.org/ns/docbook" version="5.0">
+ <title>Introduction</title>
+ <chapter xml:id="chapter_1">
+ <title>Welcome to MyApp</title>
+ <para>A very warm welcome to MyApp!</para>
+ <para>In the following, you will learn all the details about MyApp ...</para>
+ </chapter>
+ <chapter xml:id="chapter_2">
+ <title>Main Concepts</title>
+ <para>To understand how MyApp works, it important to go over some fundamental concepts first ...</para>
+ </chapter>
+ </book>

0 comments on commit 947a88e

Please sign in to comment.
Something went wrong with that request. Please try again.