mirror of https://github.com/php/php-src.git synced 2024-11-23 01:44:06 +08:00

History

DanielEScherzer 4a4574290f [skip ci] docs: fix constant syntax in stubs.rst (#15785 ) Constants are declared with `=` not `:`		2024-09-07 08:22:10 +01:00
..
source	[skip ci] docs: fix constant syntax in stubs.rst (#15785 )	2024-09-07 08:22:10 +01: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
make.bat	Create book for docs	2024-02-18 12:16:31 +01:00
README.md	Add hosted docs link to docs/README.md	2024-03-08 12:56:19 +01:00
release-process.md	Remove Travis artefacts (#15714 )	2024-09-04 01:15:10 +02:00

README.md

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.

pip install sphinx sphinx-design sphinxawesome-theme
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.