Bug #80946 [Ver]: Doc build instructions incomplete
Edit report at https://bugs.php.net/bug.php?id=80946&edit=1
ID: 80946
Updated by: cmb@php.net
Reported by: php-bugs at allenjb dot me dot uk
Summary: Doc build instructions incomplete
Status: Verified
Type: Bug
-Package: Doc Build problem
+Package: Documentation problem
PHP Version: Irrelevant
-Assigned To: cmb
+Assigned To:
Block user comment: N
Private report: N
New Comment:
I've just fixed the description in doc-base\README.md[1]. Not
sure what to do with the other places; probably a good idea to
unify and link to a canonical source.
[1] <https://github.com/php/doc-base/commit/fb807d73f70fd46026f447a8c36da9ed54d1439b>
Previous Comments:
------------------------------------------------------------------------
[2021-04-09 16:12:33] cmb@php.net
For https://github.com/php/doc-base,
git clone git@github.com:php/doc-en.git
should actually be
git clone git@github.com:php/doc-en.git en
After ./configure there should be a file doc-base/.manual.xml
(~40MB) which is the full PHP manual in DocBook format. This file
can then be fed to PhD for rendering.
------------------------------------------------------------------------
[2021-04-09 16:03:09] php-bugs at allenjb dot me dot uk
Description:
------------
The same or very similar instructions appear in 3 places I found:
https://github.com/php/doc-base (README.md)
http://doc.php.net/tutorial/local-setup.php
https://wiki.php.net/doc/phd
This is the actual sequence of commands I ended up running:
mkdir phpdoc
cd phpdoc
git clone git@github.com:php/doc-en.git
git clone git@github.com:php/doc-base.git
git clone https://github.com/php/phd.git
php phd/render.php --help
php doc-base/configure.php
cd doc-en
php ../doc-base/configure.php
Both times I ran doc-base/configure.php resulted in a "No language directory found" error.
After scanning configure.php to see what it was looking for, to fix the issue I created
'en' in the phpdoc directory, then ran doc-base/configure.php from there.
The instructions should be updated with the missing step to create the language directory.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=80946&edit=1
Thread (4 messages)