Re: Local DocBook Processing?
| From: | Peter Cowburn | Date: | Thu, 19 Mar 2015 15:54:24 +0000 |
| Subject: | Re: Local DocBook Processing? | ||
| References: | 1 2 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385482@lists.php.net to get a copy of this message | ||
On 19 March 2015 at 15:37, Patrick Schwisow <patrick.schwisow@gmail.com>
wrote:
> On Thu, Mar 19, 2015 at 10:16 AM, Hollenbeck, Scott <
> shollenbeck@verisign.com> wrote:
>
>> I'm working on the documentation for a PHP extension that I might one day
>> submit to PECL. I've successfully used docgen.php to process my extension
>> and produce DocBook XML files. How can I convert those files into PDF or
>> HTML for local viewing? I've tried Publican, but it fails with an XML
>> parser error. I've also tried dblatex, but it doesn't like the undefined
>> entity references in the book.xml file produced by docgen. Should I edit
>> book.xml and add the entity definitions manually?
>>
>> Thank you,
>> Scott Hollenbeck
>>
>
> I have yet to try it myself, but there are directions for this at
> http://doc.php.net/tutorial/local-setup.php
>
That tutorial section should be enough to get you going. Though I have a
few points where I like to do things differently.
One thing I'd mention is that I prefer working with PhD from its master
branch from Git. For example; git clone
http://git.php.net/repository/phd.git then
change the "phd" command in the
tutorial to "php /path/to/phd/render.php"
If you want to build the "PHP.net version" of the documentation, so that
you can see what it will look like in the PHP.net website, again I like to
run the website code from Git: git clone
http://git.php.net/repository/web/php.git
is enough to get started. I
usually just run the website using PHP's built-in web server: cd
/path/to/web/php/; php -S 0.0.0.0:4000 then you can view it in your browser
at localhost:4000
Then, once you have rendered the documentation with PhD, the final step to
viewing the newly rendered docs is to create a symlink for manual/en/ in
the website, pointing to the rendered docs folder.
If any of the above is not clear, but sounds like something you'd want to
do, feel free to ask.
>
>
> -Patrick
>