Skip to content

Commit

Permalink
Update the versions of sphinx and its plugins (#64)
Browse files Browse the repository at this point in the history
Updates of the theme required minor tweaks to the configuration, mostly
removing the logo from the left side bar. Had to remove the caching of
conda packages from the CI because conda fails to find packages when
it's enabled. Don't know why but remove it for now since I found no way
around it.
  • Loading branch information
leouieda authored Feb 28, 2024
1 parent 2777ee7 commit 541bb26
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 31 deletions.
18 changes: 4 additions & 14 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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: |
Expand All @@ -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: |
Expand Down
4 changes: 3 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,9 @@
# HTML output configuration
# -----------------------------------------------------------------------------
html_title = f'{project} <span class="project-version">{version}</span>'
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
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions env/requirements-docs.txt
Original file line number Diff line number Diff line change
@@ -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
15 changes: 6 additions & 9 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: choclo
channels:
- conda-forge
dependencies:
- python==3.9
- python==3.11
- pip
- make
# Run
Expand All @@ -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
Expand All @@ -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

0 comments on commit 541bb26

Please sign in to comment.