Skip to content

Commit 6d20ab9

Browse files
authoredMar 6, 2025
Merge pull request OSGeo#11925 from dbaston/doc-sphinx-driver-index
Doc: Generate driver indices via Sphinx instead of external script
2 parents fd803f4 + 0d19148 commit 6d20ab9

File tree

7 files changed

+228
-174
lines changed

7 files changed

+228
-174
lines changed
 

‎.github/workflows/doc_checks.yml

-5
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,6 @@ jobs:
8181
run: |
8282
mkdir -p doc/build
8383
doxygen Doxyfile
84-
- name: Generated RST files
85-
shell: bash -l {0}
86-
run: |
87-
make generated_rst_files
88-
working-directory: ./doc
8984
- name: Spelling
9085
shell: bash -l {0}
9186
run: |

‎.readthedocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ build:
1515
- (git --no-pager log --pretty="tformat:%s -- %b" -1 | paste -s -d " " | grep -viqP "skip ci|ci skip") || exit 183
1616
pre_build:
1717
- ./doc/rtd/pre_build.sh
18-
- cd doc && make doxygen generated_rst_files
18+
- cd doc && make doxygen
1919

2020
apt_packages:
2121
- ant

‎doc/Makefile

+5-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ BUILDDIR = build
1414
help:
1515
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1616

17-
.PHONY: help Makefile clean generated_rst_files doxygen
17+
.PHONY: help Makefile clean doxygen
1818

1919
# Catch-all target: route all unknown targets to Sphinx using the new
2020
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
@@ -67,22 +67,19 @@ $(BUILDDIR)/.doxygen_up_to_date:
6767
for i in $(BUILDDIR)/xml/*.xml; do sed "s/<ndash\/>/--/g" < $$i > $$i.tmp; mv $$i.tmp $$i; done; \
6868
touch $(BUILDDIR)/.doxygen_up_to_date
6969

70-
generated_rst_files: $(BUILDDIR)/.doxygen_up_to_date
71-
$(PYTHON) "$(SOURCEDIR)/build_driver_summary.py" "$(SOURCEDIR)/drivers/raster" raster_driver_summary "$(SOURCEDIR)/drivers/raster/driver_summary.rst"
72-
$(PYTHON) "$(SOURCEDIR)/build_driver_summary.py" "$(SOURCEDIR)/drivers/vector" vector_driver_summary "$(SOURCEDIR)/drivers/vector/driver_summary.rst"
7370

7471
.PHONY: html latexpdf
75-
html: generated_rst_files
72+
html: $(BUILDDIR)/.doxygen_up_to_date
7673
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
7774
ln -sf ../latex/gdal.pdf $(BUILDDIR)/html
7875

79-
man: generated_rst_files
76+
man:
8077
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M man "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
8178

82-
latexpdf: generated_rst_files
79+
latexpdf:
8380
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
8481

85-
spelling: generated_rst_files
82+
spelling: $(BUILDDIR)/.doxygen_up_to_date
8683
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -b spelling "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
8784

8885
clean:

0 commit comments

Comments
 (0)