commit-link" data-hovercard-type="commit" data-hovercard-url="https://github.com/hakre/php-src/commit/19d2b84788df500a62d7cb668d72419f70b73ca9/hovercard" href="https://github.com/hakre/php-src/commit/19d2b84788df500a62d7cb668d72419f70b73ca9">19d2b84 ("Create book for docs", 2024-01-30) the build of the php-src documentation has been introduced. It is based on reStructuredText (rst) [Docutils] for its source files, this stems from the sphinx-build utility in use to build the static HTML pages of the php-src documentation. The maximum line length of these text files has been set to 100 characters in 19d2b84 ("Create book for docs", 2024-01-30), the rationale is unknown to the documenting author at time of writing this message. This formatting constraint is applied with the rstfmt utility [rstfmt] via its invocation (documented in CI build instructions and README.md:) rstfmt -w 100 source The `-w, --width` option takes a WIDTH argument that is "the target line length in characters" (cf. `rstfmt --help`.) There is also an `--ext EXT` argument option, that is "the extension of files to look at when passed a directory" ("source" is the name of a directory in the invocation above) and defaults to "rst". Henceforth, the editor configuration [EditorConfig] can benefit from documenting this expectation in the repositories .editorconfig file, which has been introduced already earlier in 5c38fbe ("Added editorconfig file", 2016-06-26). [Docutils]: https://docutils.sourceforge.io/index.html "Docutils: Documentation Utilities — Written in Python, for General- and Special-Purpose Use" [rstfmt]: https://github.com/dzhu/rstfmt "A formatter for reStructuredText" [EditorConfig]: https://editorconfig.org/ "EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs"

Commits

Commits on Nov 22, 2024

Document .rst file maximum line length of 100

Makefile for php-src docs build

Bind requirements.txt for php-src docs build

Remove deprecated theme configuration