Merge pull request #11301 from rouault/doc_programoutput

Doc: use sphinxcontrib_programoutput_gdal for gdalinfo doc
OSGeo · Nov 19, 2024 · a00fbc1 · a00fbc1
2 parents fa0ac75 + abef77e
commit a00fbc1
Show file tree

Hide file tree

Showing 7 changed files with 367 additions and 287 deletions.
diff --git a/.github/workflows/doc_checks.yml b/.github/workflows/doc_checks.yml
@@ -39,7 +39,7 @@ jobs:
           cmake .. \
             -DCMAKE_BUILD_TYPE=Release \
             -DCMAKE_INSTALL_PREFIX=/usr \
-            -DBUILD_APPS=OFF \
+            -DBUILD_APPS=ON \
             -DBUILD_TESTING=OFF \
             -DGDAL_BUILD_OPTIONAL_DRIVERS=OFF \
             -DOGR_BUILD_OPTIONAL_DRIVERS=OFF

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -7,6 +7,7 @@ repos:
               (?x)^(
                 swig/python/osgeo/__init__.py|
                 swig/python/osgeo/gdalnumeric.py|
+                doc/source/_extensions/sphinxcontrib_programoutput_gdal.py|
                 autotest/ogr/data/
               )
     -   repo: https://github.com/timothycrosley/isort
@@ -17,6 +18,7 @@ repos:
               (?x)^(
                 swig/python/osgeo/__init__.py|
                 swig/python/osgeo/gdalnumeric.py|
+                doc/source/_extensions/sphinxcontrib_programoutput_gdal.py|
                 autotest/ogr/data/
               )
     -   repo: https://github.com/pycqa/flake8
@@ -27,6 +29,7 @@ repos:
               (?x)^(
                 swig/python/osgeo/__init__.py|
                 swig/python/osgeo/gdalnumeric.py|
+                doc/source/_extensions/sphinxcontrib_programoutput_gdal.py|
                 examples/|
                 autotest/ogr/data/
               )

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,14 +1,16 @@
 # This file may be used to create an environment using:
 # $ pip install --upgrade -r <this file>
+breathe
 fsspec
 numpy
 sphinx
-breathe
 sphinx_bootstrap_theme
-sphinxcontrib-bibtex
-sphinx_rtd_theme
-recommonmark
 sphinx-markdown-tables
-sphinxcontrib-spelling
+sphinx_rtd_theme
+sphinxcontrib-bibtex
 sphinxcontrib-jquery
+# We use a slightly forked version
+# sphinxcontrib-programoutput
+sphinxcontrib-spelling
 myst_nb
+recommonmark
diff --git a/doc/rtd/pre_build.sh b/doc/rtd/pre_build.sh
@@ -13,7 +13,7 @@ cmake \
     -DGDAL_PYTHON_INSTALL_PREFIX=${PREFIX} \
     -DGDAL_BUILD_OPTIONAL_DRIVERS=OFF \
     -DOGR_BUILD_OPTIONAL_DRIVERS=OFF \
-    -DBUILD_APPS=OFF \
+    -DBUILD_APPS=ON \
     -DBUILD_PYTHON_BINDINGS=ON \
     -DBUILD_JAVA_BINDINGS=ON \
     -DBUILD_TESTING=OFF \