rossriley/phrocco

PHP Port of Docco

Phrocco - Literate Documentation for PHP

Phrocco is the start of a port of the rather nice literate documentation generator Docco to PHP

http://jashkenas.github.com/docco/

Installing

Best done via composer global.

composer global require rossriley/phrocco:dev-master

This will install the binary to ~/.composer/vendor/bin/phrocco.

The project is in alpha at this stage but feedback and pull requests are welcome.

Also check out the front end site http://phrocco.info/ for more instructions and example output.

phrocco's Issues

so how do i use it?

Needs documentation

PSA: you need to install the pygmentize gem for phrocco to work.

Run sudo gem install pygmentize before running the phrocco CLI script because otherwise it makes calls to pygments.appspot.com which throws a 404. But other than that everything works great.

Pear install instructions don't quite work

┌─[jpearson@cominor] - [~/Code] - [Mon Sep 12, 08:55]
└─[$]> pear install oneblackbear.pearfarm.org/phrocco-0.2.5
Attempting to discover channel "oneblackbear.pearfarm.org"...
downloading channel.xml ...
Starting to download channel.xml (762 bytes)
....done: 762 bytes
Channel "oneblackbear.pearfarm.org" is not initialized, use "pear channel-discover oneblackbear.pearfarm.org" to initializeor pear config-set auto_discover 1
unknown channel "oneblackbear.pearfarm.org" in "oneblackbear.pearfarm.org/phrocco-0.2.5"
invalid package name/package file "oneblackbear.pearfarm.org/phrocco-0.2.5"
install failed

As the output says, I had to use channel-discover first.

"Your domain has expired"

See http://www.phrocco.info.

PHAR package

It will be good, if you will have a phar version of phrocco on your site(http://phrocco.info/).

I wrote simple script for building phar archive:

<?php
$package = new Phar(__DIR__ . '/phrocco.phar');

$includes = [
    'lib/.*',
    'vendor/.*',
    'phrocco'
];

$regexp = '#^' . implode('|', $includes) . '$#';

$package->buildFromDirectory(__DIR__, $regexp);

$package->setStub($package->createDefaultStub('phrocco'));
$package->compressFiles(Phar::BZ2);

Output directory doesn't respect absolute paths

I ran phrocco with -o /some/directory/off/root, and it put it in ./some/directory/off/root.