-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10434 from dbaston/rtd
Doc: Build documentation using ReadTheDocs
- Loading branch information
Showing
17 changed files
with
298 additions
and
353 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| # .readthedocs.yaml | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| build: | ||
| os: "ubuntu-24.04" | ||
| tools: | ||
| python: "3.12" | ||
|
|
||
| jobs: | ||
| post_checkout: | ||
| - (git --no-pager log --pretty="tformat:%s -- %b" -1 | grep -viqP "skip ci|ci skip") || exit 183 | ||
| pre_build: | ||
| - ./doc/rtd/pre_build.sh | ||
| - cd doc && make doxygen generated_rst_files | ||
|
|
||
| apt_packages: | ||
| - ant | ||
| - cmake | ||
| - doxygen | ||
| - g++ | ||
| - libproj-dev | ||
| - make | ||
| - openjdk-11-jdk-headless | ||
| - patchelf | ||
| - swig | ||
| - unzip | ||
|
|
||
| formats: | ||
| - htmlzip | ||
|
|
||
| python: | ||
| install: | ||
| - requirements: doc/requirements.txt | ||
|
|
||
| sphinx: | ||
| configuration: doc/source/conf.py | ||
| fail_on_warning: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| User-agent: * | ||
| Allow: /en/latest/ | ||
| Disallow: /en/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,16 @@ | ||
| name: gdal-docs | ||
| channels: | ||
| - conda-forge | ||
| - defaults | ||
| dependencies: | ||
| - bzip2=1.0.6=h1de35cc_1002 | ||
| - ca-certificates=2019.3.9=hecc5488_0 | ||
| - certifi=2019.3.9=py37_0 | ||
| - libcxx=8.0.0=2 | ||
| - libcxxabi=8.0.0=2 | ||
| - libffi=3.2.1=h6de7cb9_1006 | ||
| - ncurses=6.1=h0a44026_1002 | ||
| - openssl=1.1.1b=h01d97ff_2 | ||
| - pip=19.1=py37_0 | ||
| - python=3.7.3=h0d93f26_0 | ||
| - readline=7.0=hcfe32e1_1001 | ||
| - setuptools=41.0.1=py37_0 | ||
| - sqlite=3.26.0=h1765d9f_1001 | ||
| - tk=8.6.9=ha441bb4_1001 | ||
| - wheel=0.33.4=py37_0 | ||
| - xz=5.2.4=h1de35cc_1001 | ||
| - zlib=1.2.11=h1de35cc_1004 | ||
| - pip | ||
| - pip: | ||
| - alabaster==0.7.12 | ||
| - babel==2.6.0 | ||
| - beautifulsoup4==4.7.1 | ||
| - breathe==4.13.0.post0 | ||
| - bs4==0.0.1 | ||
| - chardet==3.0.4 | ||
| - docutils==0.14 | ||
| - exhale==0.2.2 | ||
| - idna==2.8 | ||
| - imagesize==1.1.0 | ||
| - jinja2==2.10.1 | ||
| - lxml==4.3.3 | ||
| - markupsafe==1.1.1 | ||
| - packaging==19.0 | ||
| - pygments==2.4.0 | ||
| - pyparsing==2.4.0 | ||
| - pytz==2019.1 | ||
| - requests==2.21.0 | ||
| - six==1.12.0 | ||
| - snowballstemmer==1.2.1 | ||
| - soupsieve==1.9.1 | ||
| - sphinx==2.0.1 | ||
| - sphinx-rtd-theme==0.4.3 | ||
| - sphinxcontrib-applehelp==1.0.1 | ||
| - sphinxcontrib-devhelp==1.0.1 | ||
| - sphinxcontrib-htmlhelp==1.0.2 | ||
| - sphinxcontrib-jsmath==1.0.1 | ||
| - sphinxcontrib-qthelp==1.0.2 | ||
| - sphinxcontrib-serializinghtml==1.1.3 | ||
| - urllib3==1.24.3 | ||
| prefix: /Users/hobu/miniconda3/envs/gdal-docs | ||
|
|
||
| - breathe | ||
| - numpy | ||
| - recommonmark | ||
| - sphinx | ||
| - sphinx-bootstrap-theme | ||
| - sphinx-markdown-tables | ||
| - sphinx-rtd-theme | ||
| - sphinxcontrib-bibtex | ||
| - sphinxcontrib-jquery | ||
| - sphinxcontrib-spelling |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| #!/bin/bash | ||
| set -ex | ||
|
|
||
| mkdir -p build-rtd | ||
| cd build-rtd | ||
|
|
||
| PREFIX=${READTHEDOCS_VIRTUALENV_PATH} | ||
|
|
||
| cmake \ | ||
| -DCMAKE_BUILD_TYPE=Debug \ | ||
| -DCMAKE_INSTALL_PREFIX=${PREFIX} \ | ||
| -DCMAKE_INSTALL_RPATH=${PREFIX}/lib \ | ||
| -DGDAL_PYTHON_INSTALL_PREFIX=${PREFIX} \ | ||
| -DGDAL_BUILD_OPTIONAL_DRIVERS=OFF \ | ||
| -DOGR_BUILD_OPTIONAL_DRIVERS=OFF \ | ||
| -DBUILD_APPS=OFF \ | ||
| -DBUILD_PYTHON_BINDINGS=ON \ | ||
| -DBUILD_JAVA_BINDINGS=ON \ | ||
| -DBUILD_TESTING=OFF \ | ||
| -DGDAL_JAVA_GENERATE_JAVADOC=ON \ | ||
| -DBASH_COMPLETIONS_DIR="" \ | ||
| .. | ||
|
|
||
| cmake --build . -j$(nproc) | ||
| cmake --install . | ||
|
|
||
| # set rpath for python libraries | ||
| find ${READTHEDOCS_VIRTUALENV_PATH} -wholename "*/osgeo/*.so" -exec patchelf --set-rpath ${READTHEDOCS_VIRTUALENV_PATH}/lib {} \; | ||
|
|
||
| # check python import (needed for doc build) | ||
| python3 -c "from osgeo import gdal; print(gdal.__version__)" | ||
|
|
||
| # unpack javadoc created during cmake --build into correct location | ||
| mkdir -p ../doc/build/html_extra | ||
| unzip -d ../doc/build/html_extra swig/java/javadoc.zip | ||
|
|
||
| # copy gdalicon.png into html_extra (used by test suite) | ||
| cp ../data/gdalicon.png ../doc/build/html_extra/ | ||
|
|
||
| # copy proj_list documentation | ||
| # see https://github.com/OSGeo/gdal/issues/8221 | ||
| git clone https://github.com/OSGeo/libgeotiff | ||
| cp -r libgeotiff/geotiff/html/proj_list ../doc/build/html_extra | ||
|
|
||
| # copy resources directory for gdal2tiles usage | ||
| # see https://github.com/OSGeo/gdal/pull/6276 | ||
| cp -r ../resources ../doc/build/html_extra/resources # Do not change this without changing swig/python/gdal-utils/osgeo_utils/gdal2tiles.py |
Oops, something went wrong.