From f19a3dca3392aa44d1d23c04b110decd9ad62e5e Mon Sep 17 00:00:00 2001 From: Daniel Baston Date: Wed, 8 Nov 2023 05:07:57 -0500 Subject: [PATCH] rtd init --- .readthedocs.yaml | 44 +++++++++++++++++++++++++++++++++ doc/environment.yml | 60 ++++++++------------------------------------- 2 files changed, 54 insertions(+), 50 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000000..9645a3679e6f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,44 @@ +# .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-22.04" + tools: + python: "mambaforge-4.10" + + jobs: + post_checkout: + - (git --no-pager log --pretty="tformat:%s -- %b" -1 | grep -viqP "skip ci|ci skip") || exit 183 + pre_build: + - mkdir build + - cd build + - cmake -DGDAL_BUILD_OPTIONAL_DRIVERS=OFF -DOGR_BUILD_OPTIONAL_DRIVERS=OFF -DBUILD_PYTHON_BINDINGS=ON -DBUILD_TESTING=OFF .. + - make -j$(nproc) + - make install + - cd ../doc + - python3 -m pip install -r requirements.txt + + apt_packages: + - cmake + - doxygen + - g++ + - libproj-dev + - python3 + - python3-pip + - swig + + +formats: + - htmlzip + - pdf + +conda: + environment: doc/environment.yml + +sphinx: + configuration: docs/source/conf.py + fail_on_warning: false diff --git a/doc/environment.yml b/doc/environment.yml index eca9065c503a..ce9ca2a6ecb2 100644 --- a/doc/environment.yml +++ b/doc/environment.yml @@ -1,55 +1,15 @@ 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 + - recommonmark + - sphinx + - sphinx-bootstrap-theme + - sphinx-markdown-tables + - sphinx-rtd-theme + - sphinxcontrib-bibtex + - sphinxcontrib-jquery + - sphinxcontrib-spelling