1# php-src docs 2 3This is the home of the php-src internal documentation, hosted at 4[php.github.io/php-src/](https://php.github.io/php-src/). It is in very early stages, but is 5intended to become the primary place where new information about php-src is documented. Over time, 6it is expected to replace various mediums like: 7 8* https://www.phpinternalsbook.com/ 9* https://wiki.php.net/internals 10* Blogs from contributors 11 12## How to build 13 14`python` 3 and `pip` are required. 15 16```bash 17pip install sphinx sphinx-design sphinxawesome-theme 18make html 19``` 20 21That's it! You can view the documentation under `./build/html/index.html` in your browser. 22 23## Formatting 24 25The files in this documentation are formatted using the 26[``rstfmt``](https://github.com/dzhu/rstfmt) tool. 27 28```bash 29rstfmt -w 100 source 30``` 31 32This tool is not perfect. It breaks on custom directives, so we might switch to either a fork or 33something else in the future. 34
