Running PDoc...

[Ken]

Hi,

Been using Proto/Scripty and have been looking for a good doc tool...
was about to us jsdoc, when I discovered PDoc... which seems to fit
better with these libraries... Downloaded it from github... but there
is no running instructions / ruby compatibility requirements, etc. How
about a few simple getting starting examples?

Thanks,

Ken

[Tobie Langel]

I agree. I'll look into this asap.

Best,

Tobie

[Ken]

Hey Tobie,

If you can get me started, I would be happy to contribute to an
operational page... Also, it would be useful to see what the end
result looks like... look before you buy (in)... a sample code and end
result tabbed page?

Cheers,

Ken

[Tobie Langel]

Hi Ken,

Thanks for the interest and feedback.

PDoc is very much in the works for now, and not ready for prime time.

I'll be looking into it shortly, but if you're interested, you might
want to look at the rakefile (and source code).

Best,

Tobie

[James Coglan]

> If you can get me started, I would be happy to contribute to an
> operational page... Also, it would be useful to see what the end
> result looks like... look before you buy (in)... a sample code and end
> result tabbed page?

Hi Ken,

I just added a commandline wrapper and a gemspec for PDoc, so you can
install it and run from anywhere. From the directory where you have
PDoc checked out, run:

git pull origin master
gem build pdoc.gemspec
sudo gem install pdoc-0.1.0.gem (omit 'sudo' on Windows)

Then, run 'pdoc -h' from any directory for usage instructions. There's
also a command to extract the templates from pdoc so you can edit
them. For example:

pdoc copy-templates html my_dir
# edit files in my_dir
pdoc my_script.js -t my_dir

Output is written to a directory 'pdoc' inside the current directory,
by default.