Adding a top level Makefile and some distribution-independent love.

This commit is contained in:
Andrew McMillan 2007-05-29 13:35:37 +12:00
parent 8b1ded004a
commit 2f53e972b8
4 changed files with 32 additions and 18 deletions

1
.gitignore vendored
View File

@ -3,3 +3,4 @@ rscds.session
build build
rscds.bfproject rscds.bfproject
locale locale
built-docs

18
Makefile Executable file
View File

@ -0,0 +1,18 @@
#!/usr/bin/make -f
#
package=rscds
all: built-docs
built-docs: docs/api/phpdoc.ini htdocs/*.php inc/*.php
phpdoc -c docs/api/phpdoc.ini
touch built-docs
clean:
rm -f built-docs
-find docs/api/* ! -name "phpdoc.ini" ! -name ".gitignore" -delete
-find . -name "*~" -delete
.PHONY: all clean

6
docs/api/.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
*.html
RSCDS
awl
media
rscds

View File

@ -1,17 +1,5 @@
;; phpDocumentor parse configuration file ;; phpDocumentor configuration file for RSCDS API documentation
;; ;;
;; This file is designed to cut down on repetitive typing on the command-line or web interface
;; You can copy this file to create a number of configuration files that can be used with the
;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web
;; interface will automatically generate a list of .ini files that can be used.
;;
;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs
;;
;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
;;
;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
;;
;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
[Parse Data] [Parse Data]
;; title of all the documentation ;; title of all the documentation
@ -43,7 +31,7 @@ defaultpackagename = RSCDS
;; output any parsing information? set to on for cron jobs ;; output any parsing information? set to on for cron jobs
;; legal values: on ;; legal values: on
;quiet = on quiet = on
;; parse a PEAR-style repository. Do not turn this on if your project does ;; parse a PEAR-style repository. Do not turn this on if your project does
;; not have a parent directory named "pear" ;; not have a parent directory named "pear"
@ -52,7 +40,7 @@ defaultpackagename = RSCDS
;; where should the documentation be written? ;; where should the documentation be written?
;; legal values: a legal path ;; legal values: a legal path
target = /home/andrew/projects/rscds/debian/html target = docs/api
;; Which files should be parsed out as special documentation files, such as README, ;; Which files should be parsed out as special documentation files, such as README,
;; INSTALL and CHANGELOG? This overrides the default files found in ;; INSTALL and CHANGELOG? This overrides the default files found in
@ -62,6 +50,7 @@ readmeinstallchangelog = README, INSTALL, CHANGELOG, NEWS, FAQ, LICENSE
;; limit output to the specified packages, even if others are parsed ;; limit output to the specified packages, even if others are parsed
;; legal values: package names separated by commas ;; legal values: package names separated by commas
;packageoutput = package1,package2 ;packageoutput = package1,package2
packageoutput = rscds,RSCDS,AWL,awl
;; comma-separated list of files to parse ;; comma-separated list of files to parse
;; legal values: paths separated by commas ;; legal values: paths separated by commas
@ -71,19 +60,19 @@ readmeinstallchangelog = README, INSTALL, CHANGELOG, NEWS, FAQ, LICENSE
;; legal values: directory paths separated by commas ;; legal values: directory paths separated by commas
;directory = /path1,/path2,.,..,subdirectory ;directory = /path1,/path2,.,..,subdirectory
;directory = /home/jeichorn/cvs/pear ;directory = /home/jeichorn/cvs/pear
directory = /home/andrew/projects/rscds/inc,/home/andrew/projects/rscds/htdocs directory = inc,htdocs
;; template base directory (the equivalent directory of <installdir>/phpDocumentor) ;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
;templatebase = /path/to/my/templates ;templatebase = /path/to/my/templates
;; directory to find any example files in through @example and {@example} tags ;; directory to find any example files in through @example and {@example} tags
;examplesdir = /path/to/my/templates ;examplesdir = /path/to/my/templates
examplesdir = /home/andrew/projects/rscds/examples examplesdir = examples
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
;; legal values: any wildcard strings separated by commas ;; legal values: any wildcard strings separated by commas
;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/ ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
ignore = .git ignore = htdocs/css/,htdocs/images/,htdocs/js/,
;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib, ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,