Skip to content

Commit

Permalink
Update the versions of sphinx and its plugins
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.
  • Loading branch information
leouieda committed Feb 28, 2024
1 parent 2777ee7 commit 408f24a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 17 deletions.
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 408f24a

Please sign in to comment.