[Solar-talk] how to build static docs

[Paul M Jones]

On Sep 25, 2006, at 11:31 AM, Paul M Jones wrote:

>
> On Sep 25, 2006, at 8:01 AM, Rodrigo Moraes wrote:
>
>> Is there an 'already done' way to build static docs using
>> Solar_Docs_Apiref?
>
> Sort of.  It's not private, but I've also not talked about it
> publicly very much; it's the system I use to generate the Solar web
> site.
>
>
>> A Japanese friend is considering  to use Solar and
>> asked me docs to read offline. Sorry to ask so quickly, but I've  
>> never
>> used the docs builder.
>
> Tell you what, I'll commit what I have to a new SVN repo today and
> you can see how it works.

Hi again Rodrigo --

I've uploaded the SolarWeb system to SVN.

   <http://solarphp.com/svn/SolarWeb/>

This is what happens when I build the Solar web site.  At the command  
line, I run "docs.php".

   <http://solarphp.com/svn/docs.php>

That invokes SolarWeb_Docs, which uses the Solar doc classes to  
extract doc-blocks, then uses that data to write one file for each  
method and property to a target location (along with overview files)  
using Solar_Markdown_Wiki syntax.

   <http://solarphp.com/svn/SolarWeb/Docs.php>

The SolarWeb_App_Docs application reads from the generated "apiref"  
directory, combines with narrative handwritten docs from a "manual"  
directory, parses and renders using Solar_Markdown_Wiki, and shows  
you the page.

   <http://solarphp.com/svn/SolarWeb/App/Docs.php>
   <http://solarphp.com/svn/SolarWeb/App/Docs>

I know this is a very brief response to a complex subject, but I hope  
it begins to help.  I also know that in many ways it is not very  
efficient, but it's the best I've got right now.

Please let me know what else you may need.


--

Paul M. Jones  <http://paul-m-jones.com>

Solar: Simple Object Library and Application Repository
for PHP5.   <http://solarphp.com>

Savant: The simple, elegant, and powerful solution for
templates in PHP.   <http://phpsavant.com>