Author: Derick Rethans Date: 2006-01-20 17:03:32 +0100 (Fri, 20 Jan 2006) New Revision: 1995
Log: - Improved doc building script so that it uses the config from the releases file #- Just trunk support left now. Added: scripts/build-php-doc-config.php scripts/get-packages-for-version.php scripts/list-export-dirs.php Modified: scripts/build-docs.sh scripts/package.php Modified: scripts/build-docs.sh =================================================================== --- scripts/build-docs.sh 2006-01-20 15:21:24 UTC (rev 1994) +++ scripts/build-docs.sh 2006-01-20 16:03:32 UTC (rev 1995) @@ -1,27 +1,47 @@ #!/bin/sh +if test $# != 1; then + echo "Usage: scripts/build-docs.sh <version>" + exit 0; +fi + +j=`php scripts/list-export-dirs.php $1` + +echo "Writing config file" +php scripts/build-php-doc-config.php $1 > /tmp/doc-components.ini || exit 1 + rm -rf /home/httpd/ezcomponents.docfix || exit 1 cd /home/httpd || exit 2 -svn co http://svn.ez.no/svn/ezcomponents ezcomponents.docfix || exit 3 +for i in $j; do + echo "Checking out $i" + svn co -q http://svn.ez.no/svn/ezcomponents/packages/$i/src ezcomponents.docfix/packages/$i/src || exit 3 + svn co -q http://svn.ez.no/svn/ezcomponents/packages/$i/docs ezcomponents.docfix/packages/$i/docs || exit 3 +done +echo "Checking out scripts" +svn co -q http://svn.ez.no/svn/ezcomponents/scripts ezcomponents.docfix/scripts || exit 3 + cd ezcomponents.docfix || exit 4 echo "Removing 'array' keyword because of a bug in phpdoc" scripts/fix-docs-array.sh || exit 5 rm -rf /home/httpd/html/components/phpdoc_gen || exit 6 rm -rf /home/httpd/html/components/cdocs.tgz || exit 7 -/usr/local/bin/phpdoc -c ezcomponents.ini | grep -v Ignored || exit 8 + +echo "Running php documentor" +/usr/local/bin/phpdoc -q -c /tmp/doc-components.ini | grep -v Ignored | grep -v Writing | grep -v Notice || exit 8 ./scripts/setup-env.sh cd packages echo "Generating Tutorials:" -for i in *; do - if test -f $i/trunk/docs/tutorial.txt; then - echo "* $i" - php ../scripts/render-tutorial.php -c $i -t /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1 +for i in $j; do + if test -f $i/docs/tutorial.txt; then + comp=`echo $i | cut -d / -f 1` + echo "* $comp" + php ../scripts/render-tutorial.php -c $comp -t /home/httpd/html/components/phpdoc_gen/ezcomponents/$1 else - echo '<div class="attribute-heading"><h1>'$i'</h1></div>' > /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1/introduction_$i.html - echo '<b>[ <a href="introduction_'$i'.html" class="menu">Introduction</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1/introduction_$i.html - echo '<b>[ <a href="classtrees_'$i'.html" class="menu">Class tree</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1/introduction_$i.html - echo '<b>[ <a href="elementindex_'$i'.html" class="menu">Element index</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1/introduction_$i.html - echo "<h1>No introduction available for $i</h1>" >> /home/httpd/html/components/phpdoc_gen/ezcomponents/1.0rc1/introduction_$i.html + echo '<div class="attribute-heading"><h1>'$i'</h1></div>' > /home/httpd/html/components/phpdoc_gen/ezcomponents/$1/introduction_$comp.html + echo '<b>[ <a href="introduction_'$i'.html" class="menu">Introduction</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/$1/introduction_$comp.html + echo '<b>[ <a href="classtrees_'$i'.html" class="menu">Class tree</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/$1/introduction_$comp.html + echo '<b>[ <a href="elementindex_'$i'.html" class="menu">Element index</a> ]</b>' >> /home/httpd/html/components/phpdoc_gen/ezcomponents/$1/introduction_$comp.html + echo "<h1>No introduction available for $i</h1>" >> /home/httpd/html/components/phpdoc_gen/ezcomponents/$1/introduction_$comp.html fi done cd .. Added: scripts/build-php-doc-config.php =================================================================== --- scripts/build-php-doc-config.php 2006-01-20 15:21:24 UTC (rev 1994) +++ scripts/build-php-doc-config.php 2006-01-20 16:03:32 UTC (rev 1995) @@ -0,0 +1,47 @@ +<?php +include 'scripts/get-packages-for-version.php'; + +if ( $argc != 2 ) +{ + echo "Usage:\n\tscripts/package.php <version>\n\tscripts/package.php 1.0beta1\n\n"; + die(); +} +$version = $argv[1]; +$fileName = "releases/$version"; +if ( !file_exists( "$fileName" ) ) +{ + echo "The releases file <$fileName> does not exist!\n\n"; + die(); +} + +$directories = ''; + +$elements = fetchVersionsFromReleaseFile( $fileName ); + +foreach ( $elements as $component => $version) +{ + $directories .= "/home/httpd/ezcomponents.docfix/packages/$component/releases/$version,"; +} + +// strip last , +$directories = substr( $directories, 0, -1 ); + +echo <<<ECHOEND +[Parse Data] +title = eZ components Manual +hidden = false +parseprivate = off +javadocdesc = off +defaultcategoryname = NoCategoryName +defaultpackagename = NoPackageName + +target = /home/httpd/html/components/phpdoc_gen/ezcomponents/$version +directory = $directories + +ignore = autoload/,*autoload.php,tests/,docs/ +output=HTML:Smarty:ezdocs +sourcecode = on + +ECHOEND; + +?> Property changes on: scripts/build-php-doc-config.php ___________________________________________________________________ Name: svn:eol-style + native Added: scripts/get-packages-for-version.php =================================================================== --- scripts/get-packages-for-version.php 2006-01-20 15:21:24 UTC (rev 1994) +++ scripts/get-packages-for-version.php 2006-01-20 16:03:32 UTC (rev 1995) @@ -0,0 +1,15 @@ +<?php +function fetchVersionsFromReleaseFile( $fileName ) +{ + $versions = array(); + $definition = file( $fileName ); + foreach ( $definition as $defLine ) + { + if ( preg_match( '@([A-Za-z]+):\s+([A-Za-z0-9.]+)@', $defLine, $matches ) ) + { + $versions[$matches[1]] = $matches[2]; + } + } + return $versions; +} +?> Property changes on: scripts/get-packages-for-version.php ___________________________________________________________________ Name: svn:eol-style + native Added: scripts/list-export-dirs.php =================================================================== --- scripts/list-export-dirs.php 2006-01-20 15:21:24 UTC (rev 1994) +++ scripts/list-export-dirs.php 2006-01-20 16:03:32 UTC (rev 1995) @@ -0,0 +1,26 @@ +<?php +include 'scripts/get-packages-for-version.php'; + +if ( $argc != 2 ) +{ + echo "Usage:\n\tscripts/package.php <version>\n\tscripts/package.php 1.0beta1\n\n"; + die(); +} +$version = $argv[1]; +$fileName = "releases/$version"; +if ( !file_exists( "$fileName" ) ) +{ + echo "The releases file <$fileName> does not exist!\n\n"; + die(); +} + +$directories = ''; + +$elements = fetchVersionsFromReleaseFile( $fileName ); + +foreach ( $elements as $component => $version) +{ + echo "$component/releases/$version\n"; +} + +?> Property changes on: scripts/list-export-dirs.php ___________________________________________________________________ Name: svn:eol-style + native Modified: scripts/package.php =================================================================== --- scripts/package.php 2006-01-20 15:21:24 UTC (rev 1994) +++ scripts/package.php 2006-01-20 16:03:32 UTC (rev 1995) @@ -1,5 +1,7 @@ #!/usr/local/bin/php <?php +include 'scripts/get-packages-for-version.php'; + if ( $argc != 2 ) { echo "Usage:\n\tscripts/package.php <version>\n\tscripts/package.php 1.0beta1\n\n"; @@ -32,7 +34,7 @@ echo "Done\n"; echo "Generating HTML version of changelog: "; -`cd $basePackageDir; rst2html.py ezcomponents-$version/ChangeLog > /tmp/ezcomponents-$version.changelog.html`; +`cd $basePackageDir; rst2html ezcomponents-$version/ChangeLog > /tmp/ezcomponents-$version.changelog.html`; echo "Done\n"; echo "scp-ing to tequila: "; @@ -45,18 +47,16 @@ // Open ChangeLog file $fp = fopen( "$packageDir/ChangeLog", "w" ); echo "Exporting packages from SVN: \n"; - $definition = file( $fileName ); - foreach ( $definition as $defLine ) + + $elements = fetchVersionsFromReleaseFile( $fileName ); + foreach ( $elements as $component => $versionNr ) { - if ( preg_match( '@([A-Za-z]+):\s+([A-Za-z0-9.]+)@', $defLine, $matches ) ) - { - $changeLog = addPackage( $packageDir, $matches[1], $matches[2] ); - $title = "Component: {$matches[1]}"; - $titleHeader = str_repeat( '=', strlen( $title ) ); - fwrite( $fp, "$titleHeader\n$title\n$titleHeader\n" ); - fwrite( $fp, $changeLog ); - fwrite( $fp, "\n\n" ); - } + $changeLog = addPackage( $packageDir, $component, $versionNr ); + $title = "Component: {$component}"; + $titleHeader = str_repeat( '=', strlen( $title ) ); + fwrite( $fp, "$titleHeader\n$title\n$titleHeader\n" ); + fwrite( $fp, $changeLog ); + fwrite( $fp, "\n\n" ); } fclose( $fp ); } -- svn-components mailing list [email protected] http://lists.ez.no/mailman/listinfo/svn-components
