Commit 1e82ef9
committed
Makefile for php-src docs build
In 19d2b84 ("Create book for docs", 2024-01-30) the php-src
documentation (php-src docs) build has been introduced, yet the build
instructions, namely `make html`, did not yield the expected results
within the parenting setup of the php-src project on *nix systems.
The reason is that the `make html` build instruction does not execute
the make.bat file which contains the recipe to build the static HTML
pages. This is because — different to Windows systems — *nix systems
do not have the concept of [COMSPEC] etc. for executables, and
therefore we cannot expect for build scripts an interpreter for the
batch file.
Adding a Makefile suffices to recover the build of php-src ./docs on a
*nix system.
NOTE: The "help" target has been intentionally left out as this Sphinx
builder [1] (with the same name) is not available in the configuration,
nor in use in CI (.github/workflows/docs.yml), and otherwise appeared
undocumented. Consequentially, the makefile goal does not include it,
as well as a target for any other unspecfied builder.
[COMSPEC]: https://en.wikipedia.org/wiki/COMSPEC "COMSPEC or ComSpec is one of the environment variables used in DOS, OS/2 and Windows, which normally points to the command line interpreter, which is by default COMMAND.COM in DOS,[1] Windows 95, 98, and ME or CMD.EXE in OS/2 and Windows NT. — Wikipedia"
[1]: https://www.sphinx-doc.org/en/master/usage/builders/index.html "Built-in Sphinx builders"1 parent 63bd0f4 commit 1e82ef9
1 file changed
+29
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
0 commit comments