Changes between Version 7 and Version 8 of PhpdocPlugin
- Timestamp:
- Mar 22, 2016, 10:06:33 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PhpdocPlugin
v7 v8 44 44 You may prefer the easy_install way: 45 45 {{{#!sh 46 sudo easy_install http ://trac-hacks.org/svn/phpdocplugin/0.1146 sudo easy_install https://trac-hacks.org/svn/phpdocplugin/0.11 47 47 }}} 48 48 49 You may need to restart web server to see PHPDoc button in navigation tab. 50 51 add the following to your configuration: 49 You may need to restart your web server to see a PHPDoc button in the navigation tab. 52 50 53 51 == Configuration … … 55 53 A `[phpdoc]` section should be created in TracIni. 56 54 There is only one mandatory setting, it is the `path` to the generated documentation. 57 This should match the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.target -t] parameter of the phpdoc command. If that is a relative path, you'll need to prepend the current working directory used 58 when running `phpdoc`. 55 This should match the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.target -t] parameter of the phpdoc command. If that is a relative path, you'll need to prepend the current working directory used when running `phpdoc`. 59 56 60 57 Also, don't forget to grant the users the PHPDOC_VIEW permission, or you'll just get a blank page. 61 58 62 Note that there's also the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output -o] 63 parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'. 59 Note that there's also the [http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#using.command-line.output -o] parameter which might play a role here. I got best results with the value 'HTML:Smarty:PHP'. 64 60 65 61 == Example … … 73 69 svn co http://my.svn.server.org/svn/myproject/trunk source 74 70 mkdir doc 75 / whereever/you/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc71 /path/to/installed/phpdoc -o HTML:Smarty:PHP -d source -t doc 76 72 }}} 77 73 78 Now you should have the latest source in /var/cache/phpdoc/myproject/source 79 And the generated documentation in /var/cache/phpdoc/myproject/doc 74 Now you should have the latest source in `/var/cache/phpdoc/myproject/source` and the generated documentation in `/var/cache/phpdoc/myproject/doc`. 80 75 81 76 Now setup Trac's configuration: … … 90 85 On a first view, it appears to work good enough for me with this source and configuration. 91 86 92 '''Note''': If you install the plugin globally, you'll also need to enable it in trac.inias follows:87 '''Note''': If you install the plugin globally, you'll also need to enable it in `trac.ini` as follows: 93 88 {{{#!ini 94 89 [components]