Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:122361
MIME-Version: 1.0
References: <CAPyj-LCnOYmMv4b0bxGaHsS-0j8ptjTt95f48Zt_JUQh6NB_8g@mail.gmail.com>
 <CAEPPVa0rUkgajvApdiA+KVQMKALnG2cFTCPisanKSx1hbc6h=A@mail.gmail.com>
In-Reply-To: <CAEPPVa0rUkgajvApdiA+KVQMKALnG2cFTCPisanKSx1hbc6h=A@mail.gmail.com>
Date: Mon, 12 Feb 2024 12:11:26 +0100
Message-ID: <CAPyj-LAeaiv64_7Y_RUsRf9wHOdbfAYqtUvr-Qu36OrN_OKjxQ@mail.gmail.com>
To: PHP internals <internals@lists.php.net>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Subject: Re: [PHP-DEV] php-src docs
From: tovilo.ilija@gmail.com (Ilija Tovilo)

Hi Yuya

It seems you accidentally sent your response to me instead of the list.

On Sun, Feb 11, 2024 at 5:10=E2=80=AFPM youkidearitai <youkidearitai@gmail.=
com> wrote:
>
> 2024=E5=B9=B42=E6=9C=8811=E6=97=A5(=E6=97=A5) 21:18 Ilija Tovilo <tovilo.=
ilija@gmail.com>:
> >
> > Hi everyone.
> >
> > I would like to start an initiative to centralize documentation of the
> > PHP internals.
> > https://github.com/php/php-src/pull/13338
> > https://iluuu1994.github.io/php-src/ (will be moved to php.github.io
> > once merged)
> >
> > Let me know of any thoughts and suggestions you might have.
>
> Hi, Ilija.
> Thank you for your great suggestion.
>
> It seems make sense to have a set of documents about the structure of
> php-src in php-src.
> Easily create pull requests to them.
>
> Although I have to learn reStructuredText, It is not seems major problem.

For some context, I initially planned to go with the mdBook from the
Rust project (https://github.com/rust-lang/mdBook/) as Markdown is a
bit more approachable. After writing the sample zval chapter, I
noticed some pain points in terms of formatting, most significantly
tables. That said, reStructuredText is far from perfect itself.

As mentioned previously, the other reason for choosing Sphinx was that
it is quite extensible.

Ilija