On 24.03.22 12:23, Even Rouault wrote:
- I wasn't able to figure out how to build the docs? cmake
-DBUILD_DOCS=On works so far as cmake configuration succeeds. Then
make documentation fails with missing br/ru localized files, and
commenting those targets out there seems to be a mismatch between the
footer name (gdal_footer.html vs footer.html?)
Yes I noticed that too a few days ago :
https://github.com/OSGeo/gdal/issues/5484 . The doc for now is to be
built manually with "make html" / "make man" from the doc
subdirectory. But since the switch of the doc from static HTML pages
(I suspect the doc/CMakeLists.txt originally dates back to that era)
to Sphinx a few years ago, we no longer delivered the doc/ in tarballs
(only the generated man pages were). They got re-included in alpha1 a
bit by accident (since the move of the content of the gdal/ directory
to the top level directory, and the mkgdaldist.sh script not taking
that yet fully into account).
I'm not sure what to do with docs:
- do like we did in recent versions, ie have no doc/ directory in the
tarball, and just generated man pages (will need
https://github.com/OSGeo/gdal/issues/5491 to be implemented to
automatically have CMake to install the generated man pages)
- or ship doc/ in tarballs, and thus make sphinx-build and other
related Python packages
(https://github.com/OSGeo/gdal/blob/master/doc/requirements.txt) a
requirement to build the HTML, PDF and man pages (I know this isn't
popular for some packagers).
- variant of the above: ship doc/ in tarballs, with the addition of
pre-generated man pages. That way, only people that want the HTML &
PDF doc really need to go through sphinx-build.
I'd for for either the first or third option.
Thanks
Sandro
_______________________________________________
gdal-dev mailing list
gdal-dev@lists.osgeo.org
https://lists.osgeo.org/mailman/listinfo/gdal-dev
