DOC: add section about Xarray datasets #120
Workflow file for this run
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
| name: Check different Sphinx and Python versions | |
| on: [push, pull_request] | |
| env: | |
| PYTHONWARNINGS: error | |
| APT_INSTALL: sudo apt-get install -y --no-install-recommends | |
| PIP: python -m pip | |
| SPHINX: python -m sphinx -W --keep-going --color | |
| SPHINX_PACKAGE: "sphinx" | |
| PYTHON_VERSION: "3" | |
| jobs: | |
| version-matrix: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| # default Python, latest Sphinx | |
| - env: {} | |
| # a few older Sphinx releases using default Python version | |
| - env: | |
| SPHINX_PACKAGE: "sphinx==5.0.0 sphinxcontrib-bibtex==2.5.0" | |
| - env: | |
| SPHINX_PACKAGE: "sphinx==5.3.0 sphinxcontrib-bibtex==2.5.0" | |
| - env: | |
| SPHINX_PACKAGE: "sphinx==6.2.1 sphinxcontrib-bibtex==2.5.0" | |
| - env: | |
| SPHINX_PACKAGE: "sphinx==7.0.1" | |
| - env: | |
| SPHINX_PACKAGE: "sphinx==7.1.2" | |
| # a few Python versions using latest Sphinx release | |
| - env: | |
| PYTHON_VERSION: "3.8" | |
| - env: | |
| PYTHON_VERSION: "3.10" | |
| - env: | |
| PYTHON_VERSION: "3.13-dev" | |
| PYTHONWARNINGS: default | |
| env: ${{ matrix.env || fromJSON('{}') }} | |
| steps: | |
| - name: Clone repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Install apt packages | |
| run: | | |
| $APT_INSTALL pandoc librsvg2-bin | |
| - name: Set up Python ${{ env.PYTHON_VERSION }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ env.PYTHON_VERSION }} | |
| - name: Show Python version | |
| run: | | |
| python --version | |
| - name: Install Sphinx | |
| env: | |
| # DeprecationWarning: Unimplemented abstract methods {'locate_file'} | |
| # https://github.com/pypa/pip/issues/11684 | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $PIP install $SPHINX_PACKAGE | |
| - name: Install nbsphinx | |
| env: | |
| # DeprecationWarning: Unimplemented abstract methods {'locate_file'} | |
| # https://github.com/pypa/pip/issues/11684 | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $PIP install . | |
| - name: Install docs dependencies | |
| env: | |
| # DeprecationWarning: Unimplemented abstract methods {'locate_file'} | |
| # https://github.com/pypa/pip/issues/11684 | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $PIP install -r doc/requirements.txt --upgrade-strategy only-if-needed | |
| - name: Run Sphinx (HTML) | |
| env: | |
| # There is a weird warning from jupyter_core (https://github.com/jupyter/jupyter_core/issues/398) | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $SPHINX doc _build -b html | |
| - name: Run Sphinx (LaTeX, but without running LaTeX) | |
| env: | |
| # There is a weird warning from jupyter_core (https://github.com/jupyter/jupyter_core/issues/398) | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $SPHINX doc _build -b latex | |
| - name: Run Sphinx (epub) | |
| env: | |
| # There is a weird warning from jupyter_core (https://github.com/jupyter/jupyter_core/issues/398) | |
| PYTHONWARNINGS: error,default::DeprecationWarning | |
| run: | | |
| $SPHINX doc _build -b epub |