search

bioperl / bioperl.github.io

The BioPerl Web site: http://bioperl.org
14 stars 9 forks source link

pdoc class/package documentation for bioperl modules #41

Open dandaman opened 7 years ago

dandaman commented 7 years ago

Hi,

Christ Fields suggested I post this as a feature request. Sometime around the switch to the wiki the very useful pdoc documentation available via http://doc.bioperl.org/ was lost.

Although the pdoc project is not very active anymore the auto-generated html documentation based on POD was very useful to lookup your favorite method or its return arguments...

I wouldn't mind a more fancy solution like readthedocs, anything is better than looking for module documentation in CPAN ;-) A searchable page that lists all modules, methods and lets you switch between code view and documentation would be great.

https://web.archive.org/web/20150906082634/http://doc.bioperl.org/bioperl-live/

Best, Daniel

carandraug commented 7 years ago

I wouldn't mind a more fancy solution like readthedocs, anything is better than looking for module documentation in CPAN ;-) A searchable page that lists all modules, methods and lets you switch between code view and documentation would be great.

Do you know about metacpan? It's not exactly the same as the previous pdoc but I find it much better than search.cpan, and has a link on the side panels straight to the code.

cjfields commented 5 years ago

From the maintenance perspective I support pointing users to metacpan; maintaining a separate source for the same documentation doesn't seem particularly useful in a project with a couple of maintainers.