mirror of
https://github.com/php/php-src.git
synced 2025-08-15 21:48:51 +02:00
f906fad985
* Clarify that placeholders with `RCn` are not just for release candidates * Only PHP `X.Y.0` has pre-GA releases, no need to use `X.Y.Z` * Before `PHP-X.Y` has been created, `master` needs to be pushed for NEWS |
||
|---|---|---|
| .. | ||
| source | ||
| .gitignore | ||
| mailinglist-rules.md | ||
| Makefile | ||
| README.md | ||
| release-process.md | ||
| requirements.txt | ||
php-src docs
This is the home of the php-src internal documentation, hosted at php.github.io/php-src/. It is in very early stages, but is intended to become the primary place where new information about php-src is documented. Over time, it is expected to replace various mediums like:
- https://www.phpinternalsbook.com/
- https://wiki.php.net/internals
- Blogs from contributors
How to build
python 3 and pip are required.
cd docs
# Recommended: Initialize and activate a Python virtual environment
pip install --upgrade pip
pip install -r requirements.txt
make html
That's it! You can view the documentation under ./build/html/index.html in
your browser.
Formatting
The files in this documentation are formatted using the
rstfmt tool.
rstfmt -w 100 source
This tool is not perfect. It breaks on custom directives, so we might switch to either a fork or something else in the future.