>> Come to think of it, if the API reference webpages can be
>> completely autogenerated we don't need to store their source in the
>> freetype-web repo, we can just create a CI job in the main freetype
>> repo that will update the website with the latest content from
>> docwriter on every update to master.
> 
> The docs are built for each version before release and reflect the
> API reference as of that version.  Building docs from master means
> having stuff in the reference that may or may not be a part of the
> latest release and is generally not a good idea unless we maintain
> multiple copies of the docs that specify the version number (or
> master, for the latest built docs).

Well, there might be 'last release' and 'development' API pages, and
both could be autogenerated, no?

> However, the CI stuff is a good idea. If Werner is open to this, we
> can probably automate part (or whole, eventually) of the release
> process by automatically building the API reference (along with
> other 'release' actions) when a new release is tagged on the repo.

Yes.  It should basically do the same thing as `make refdoc` so that a
forthcoming tarball contains exactly the same as the automatically
generated online documentation.


    Werner

Reply via email to