2022.06.04 21:18 "Re: [Tiff] Conversion of HTML documentation to Sphinx ReStructuredText (RST)", by Roger

Hi folks,

To follow up to my message from last week. I have completed the initial bulk conversion and there is now a MR open for this here: https://gitlab.com/libtiff/libtiff/-/merge_requests/349

This needs two prerequisites to build: (1) python sphinx and (2) sphinx_rtd_theme. The CI has been updated to build this, and if you install them yourself you can build locally with either CMake or Autotools.

You can also see a staged copy of the documentation here: http://rleigh.gitlab.io/libtiff/ (content will replace http://libtiff.gitlab.io/libtiff/ once merged).

As mentioned before, this is just the initial conversion with minor changes only. It still needs a thorough read to pick out any lingering HTML tags or inconsistent formatting which wasn't picked up on the initial passes. It provides links to the HTML manual pages, but no deeper integration than page links at this point (no cross-references or search).

Any feedback on the conversion so far would be appreciated. If everyone is generally happy with the direction this takes us, we can follow up with a cleanup and reorganisation of the documentation to make the structure more logical and consistent, and remove duplicated or obsolete parts. And then we can repeat the conversion for the manual page content as well.

Kind regards,

Roger