php-src/docs
Arnaud Le Blanc 7b4c14dc10
Make OPcache non-optional
This removes the --enable-opcache/--disable-opcache configure switch. OPcache
is now always builtin. The default value of opcache.enable and
opcache.enable_cli is unchanged.

RFC: https://wiki.php.net/rfc/make_opcache_required

Closes GH-18961.

Co-authored-by: Tim Düsterhus <tim@tideways-gmbh.com>
2025-07-27 09:40:22 +02:00
..
source [RFC] Add support for attributes on compile-time constants 2025-04-29 11:53:09 -07:00
.gitignore Create book for docs 2024-02-18 12:16:31 +01:00
mailinglist-rules.md Move back mailinglist-rules.md and release-process.md back to docs 2024-02-28 11:21:26 +00:00
Makefile Improve php-src docs sphinx build, also on *nix (GH-16743) 2024-11-29 19:29:00 +01:00
README.md Improve php-src docs sphinx build, also on *nix (GH-16743) 2024-11-29 19:29:00 +01:00
release-process.md Make OPcache non-optional 2025-07-27 09:40:22 +02:00
requirements.txt Improve php-src docs sphinx build, also on *nix (GH-16743) 2024-11-29 19:29:00 +01:00

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:

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.