diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 11fb24f1..d37dd7fb 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -33,7 +33,7 @@ jobs: runs-on: ubuntu-latest env: REQUIREMENTS: env/requirements-docs.txt env/requirements-build.txt - PYTHON: 3.9 + PYTHON: "3.11" steps: # Checks-out your repository under $GITHUB_WORKSPACE @@ -54,14 +54,10 @@ jobs: run: git fetch origin 'refs/tags/*:refs/tags/*' - name: Setup Miniconda - uses: conda-incubator/setup-miniconda@v2 + uses: conda-incubator/setup-miniconda@v3 with: python-version: ${{ env.PYTHON }} - miniforge-variant: Mambaforge - use-mamba: true channels: conda-forge,defaults - # Needed for caching - use-only-tar-bz2: true - name: Collect requirements run: | @@ -81,17 +77,11 @@ jobs: echo "Collected dependencies:" cat requirements-full.txt - - name: Setup caching for conda packages - uses: actions/cache@v2 - with: - path: ~/conda_pkgs_dir - key: conda-${{ runner.os }}-${{ env.PYTHON }}-${{ hashFiles('requirements-full.txt') }} - - name: Install requirements - run: mamba install --quiet --file requirements-full.txt python==$PYTHON + run: conda install --quiet --file requirements-full.txt python==$PYTHON - name: List installed packages - run: mamba list + run: conda list - name: Build source and wheel distributions run: | diff --git a/doc/conf.py b/doc/conf.py index f1416637..8d7428fe 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -64,7 +64,9 @@ # HTML output configuration # ----------------------------------------------------------------------------- html_title = f'{project} {version}' -html_logo = "_static/choclo-logo.png" +# Don't use the logo since it gets in the way of the project name and is +# repeated in the front page. +# html_logo = "_static/choclo-logo.png" html_favicon = "_static/favicon.png" html_last_updated_fmt = "%b %d, %Y" html_copy_source = True diff --git a/doc/index.rst b/doc/index.rst index 280f6dc2..1dfec14c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -21,7 +21,7 @@ .. image:: ./_static/choclo-logo.svg :width: 200px - :class: sd-m-auto + :class: sd-m-auto dark-light **Choclo** is a Python library that hosts optimized forward modelling and kernel functions for running geophysical forward and inverse models, intended diff --git a/env/requirements-docs.txt b/env/requirements-docs.txt index 8740184f..396cfa7b 100644 --- a/env/requirements-docs.txt +++ b/env/requirements-docs.txt @@ -1,9 +1,7 @@ # Requirements for building the documentation -sphinx==4.5.* -sphinx-book-theme==0.3.* +sphinx==7.2.* +sphinx-book-theme==1.1.* sphinx-copybutton==0.5.* -sphinx-design==0.1.* -jupyter-sphinx=0.4.* -numpy -numba +sphinx-design==0.5.* +jupyter-sphinx==0.5.* matplotlib diff --git a/environment.yml b/environment.yml index df6f3bc4..9bb65e59 100644 --- a/environment.yml +++ b/environment.yml @@ -2,7 +2,7 @@ name: choclo channels: - conda-forge dependencies: - - python==3.9 + - python==3.11 - pip - make # Run @@ -16,11 +16,11 @@ dependencies: - pytest-cov - coverage # Documentation - - sphinx==4.5.* - - sphinx-book-theme==0.3.* + - sphinx==7.2.* + - sphinx-book-theme==1.1.* - sphinx-copybutton==0.5.* - - sphinx-design==0.1.* - - jupyter-sphinx==0.4.* + - sphinx-design==0.5.* + - jupyter-sphinx==0.5.* - matplotlib # Style - black @@ -33,8 +33,5 @@ dependencies: - flake8-mutable - flake8-rst-docstrings - flake8-simplify + - flake8-unused-arguments - pep8-naming - - pip: - # Install flake8-unused-arguments through pip - # (not available through conda yet) - - flake8-unused-arguments