Bug #80946 [Com]: Doc build instructions incomplete
| From: | php-bugs at allenjb dot me dot uk | Date: | Sat, 17 Apr 2021 10:08:02 +0000 |
| Subject: | Bug #80946 [Com]: Doc build instructions incomplete | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-18708@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=80946&edit=1
ID: 80946
Comment by: php-bugs at allenjb dot me dot uk
Reported by: php-bugs at allenjb dot me dot uk
Summary: Doc build instructions incomplete
Status: Verified
Type: Bug
Package: Documentation problem
PHP Version: Irrelevant
Block user comment: N
Private report: N
New Comment:
Not sure if this should maybe be a separate issue, but I just found http://doc.php.net/phd/docs/ via a google search, which
refers to installing phd from the (as far as I can tell) no longer present svn repo
Previous Comments:
------------------------------------------------------------------------
[2021-04-12 12:19:02] cmb@php.net
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>
------------------------------------------------------------------------
[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