mirror of
https://github.com/php/php-src.git
synced 2026-10-28 17:56:50 +08:00
Calvin Buckley
1bb25ce0f5
After php/web-php@b24d3106d4, the paths to some files changes. After php/web-php#1998 is merged to fix the tools that generate these files, this should be merged as well.
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.