New Contributions API Site Launched
I've launched a site to provide reference documentation for contributed modules: http://api.freestylesystems.co.uk/ At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form: http://api.freestylesystems.co.uk/module-request If you have any suggestions, please use let me know: http://api.freestylesystems.co.uk/suggest psynaptic http://freestylesystems.co.uk
Looks great! Any way to launch this on drupal.org? Margie On Sun, May 4, 2008 at 4:11 PM, Richard Burford <rich@freestylesystems.co.uk> wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
http://api.freestylesystems.co.uk/module-request
If you have any suggestions, please use let me know:
http://api.freestylesystems.co.uk/suggest
psynaptic http://freestylesystems.co.uk
Hi Margie, Thanks! I hope it will be of use to you. Maybe api.drupal.org would be the best place for this but for now I'm happy to provide it. psynaptic http://freestylesystems.co.uk On 5 May 2008, at 02:59, Marjorie Roswell wrote:
Looks great! Any way to launch this on drupal.org?
Margie
On Sun, May 4, 2008 at 4:11 PM, Richard Burford <rich@freestylesystems.co.uk> wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
http://api.freestylesystems.co.uk/module-request
If you have any suggestions, please use let me know:
http://api.freestylesystems.co.uk/suggest
psynaptic http://freestylesystems.co.uk
On 05.05.2008 04:11, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
my Drupal site has api doc for the CVS HEAD version of *all* contributed modules: http://drupal.kollm.org/node/1 . ax
Hi ax, I guess you just do a CVS checkout of all the HEAD versions of the modules and update the documentation from that? How much disk space does the contributions/modules directory use? I'd love to know whether others think it would be good to provide documentation for all the contributed modules. psynaptic http://freestylesystems.co.uk On 5 May 2008, at 09:09, Axel Kollmorgen wrote:
On 05.05.2008 04:11, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules: http://api.freestylesystems.co.uk/ At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
my Drupal site has api doc for the CVS HEAD version of *all* contributed modules: http://drupal.kollm.org/node/1 .
ax
On 05.05.2008 17:52, Richard Burford wrote:
On 5 May 2008, at 09:09, Axel Kollmorgen wrote:
On 05.05.2008 04:11, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
my Drupal site has api doc for the CVS HEAD version of *all* contributed modules: http://drupal.kollm.org/node/1 .
I guess you just do a CVS checkout of all the HEAD versions of the modules and update the documentation from that? How much disk space does the contributions/modules directory use?
a `cvs -z9 up -dP`, right. the size of the cvs checkout (of the whole contrib repos incl. themes, sandbox, translations, etc.) is 512,223,582 bytes (modules: 288,594,191), the generated doxygen documentation (incl. .png's for uml diagrams and directory structures, indices, etc.) 348,937,647 bytes (modules: cannot tell because doxygen generates a flat directory structure), the downloadable drupal-contrib-phpdoc.tgz 57,582,634 bytes, the error log 4,753,805 bytes. it takes doxygen about 30 minutes to generate the full documentation.
I'd love to know whether others think it would be good to provide documentation for all the contributed modules.
definitely - go ahead. curious about the load of api.module for the whole contrib repos. ax
On 05.05.2008 17:52, Richard Burford wrote:
On 5 May 2008, at 09:09, Axel Kollmorgen wrote:
On 05.05.2008 04:11, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
my Drupal site has api doc for the CVS HEAD version of *all* contributed modules: http://drupal.kollm.org/node/1 .
I guess you just do a CVS checkout of all the HEAD versions of the modules and update the documentation from that? How much disk space does the contributions/modules directory use?
a `cvs -z9 up -dP`, right. the size of the cvs checkout (of the whole contrib repos incl. themes, sandbox, translations, etc.) is 512,223,582 bytes (modules: 288,594,191), the generated doxygen documentation (incl. .png's for uml diagrams and directory structures, indices, etc.) 348,937,647 bytes (modules: cannot tell because doxygen generates a flat directory structure), the downloadable drupal-contrib-phpdoc.tgz 57,582,634 bytes, the error log 4,753,805 bytes. it takes doxygen about 30 minutes to generate the full documentation.
I'd love to know whether others think it would be good to provide documentation for all the contributed modules.
definitely - go ahead. curious about the load of api.module for the whole contrib repos. ax
Quoting Axel Kollmorgen <axel@kollmorgen.net>:
On 05.05.2008 04:11, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
my Drupal site has api doc for the CVS HEAD version of *all* contributed modules: http://drupal.kollm.org/node/1 .
Axel, thanks for this work. It is a great tool for finding global references by all modules; especially those that might coincide with the global references I might be using in my modules. I will make great use of this tool. Earnie -- http://for-my-kids.com/ -- http://give-me-an-offer.com/
On Sunday, 4. May 2008, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
I assume those modules are updated automatically once they're in, right? If so, I'll probably request one or two of my modules to be added :) Great stuff, both yours and Axel's site... finally I can see my extensive apidox in their "original" HTML format! Thanks, and wishes, Jakob
At the moment everything is manual. My current host doesn't have CVS so I'm looking into grabbing individual modules another way. I'll post more when I get some time to look into it. Feel free to submit requests for more modules and I'll add them manually for the time being. Maybe I should get a better server... psynaptic http://freestylesystems.co.uk On 5 May 2008, at 18:03, Jakob Petsovits wrote:
On Sunday, 4. May 2008, Richard Burford wrote:
I've launched a site to provide reference documentation for contributed modules:
http://api.freestylesystems.co.uk/
At the moment there are only a handful of contributed modules being documented in the Contributions API but you can request more modules using the request form:
I assume those modules are updated automatically once they're in, right? If so, I'll probably request one or two of my modules to be added :)
Great stuff, both yours and Axel's site... finally I can see my extensive apidox in their "original" HTML format!
Thanks, and wishes, Jakob
The goal for api.drupal.org is documenting every version of every theme and every module, and make it possible to easily do this for your own set of modules on your Drupal site. On Mon, May 5, 2008 at 2:55 PM, Richard Burford <rich@freestylesystems.co.uk> wrote:
At the moment everything is manual. My current host doesn't have CVS so I'm looking into grabbing individual modules another way. I'll post more when I get some time to look into it. Feel free to submit requests for more modules and I'll add them manually for the time being.
This is one of a handful of reasons contributions documentation is not on the official api.drupal.org site. Even with CVS, the process is quite manual: * Find branches (versions) of the module * Make checkouts for each * Add cvs update commands to a shell script * Add branch to the API admin page. With ~2500 modules making new branches every day, this is not something I will take on as-is. Additionally, the UI has no concept of projects. I believe the current situation would get confusing quickly. I wrote up a summary of the work needed at http://groups.drupal.org/node/11263. -- Neil Drumm http://delocalizedham.com
participants (6)
-
Axel Kollmorgen -
Earnie Boyd -
Jakob Petsovits -
Marjorie Roswell -
Neil Drumm -
Richard Burford