Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from OSGeo:master #208

Merged
merged 2 commits into from
Mar 6, 2025
+228 −174
Merged

[pull] master from OSGeo:master #208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d19148
Doc: Generate driver indices via Sphinx instead of external script
dbaston Mar 5, 2025
6d20ab9
Merge pull request #11925 from dbaston/doc-sphinx-driver-index
rouault Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .github/workflows/doc_checks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,6 @@ jobs:
run: |
mkdir -p doc/build
doxygen Doxyfile
- name: Generated RST files
shell: bash -l {0}
run: |
make generated_rst_files
working-directory: ./doc
- name: Spelling
shell: bash -l {0}
run: |
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ build:
- (git --no-pager log --pretty="tformat:%s -- %b" -1 | paste -s -d " " | grep -viqP "skip ci|ci skip") || exit 183
pre_build:
- ./doc/rtd/pre_build.sh
- cd doc && make doxygen generated_rst_files
- cd doc && make doxygen

apt_packages:
- ant
Expand Down
13 changes: 5 additions & 8 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ BUILDDIR = build
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile clean generated_rst_files doxygen
.PHONY: help Makefile clean doxygen

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

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

.PHONY: html latexpdf
html: generated_rst_files
html: $(BUILDDIR)/.doxygen_up_to_date
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
ln -sf ../latex/gdal.pdf $(BUILDDIR)/html

man: generated_rst_files
man:
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M man "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

latexpdf: generated_rst_files
latexpdf:
BUILDDIR="${BUILDDIR}" $(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

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

clean:
Expand Down
Loading
Loading