search

NOAA-GFDL / fre-cli

Python-based command line interface for FRE (FMS Runtime Environment) to compile and run FMS-based models and post-process their output.
GNU Lesser General Public License v3.0
3 stars 7 forks source link

Tracking Issue: Sphinx doc build failures #124

Closed ilaflott closed 1 month ago

ilaflott commented 1 month ago

This all started when the sphinx doc build failed with v7.4.4 and pip installed themes.

Describe the bug documentation step of workflow broken as of https://pypi.org/project/Sphinx/7.4.4/#history error message is:

Theme error:
An error happened in rendering the page FAQ.
Reason: UndefinedError("'style' is undefined")

source of the problem is the pip installed templates: https://github.com/NOAA-GFDL/fre-cli/blob/28908cb257c403062cbd7f6e14fa71eb6a0b28cb/.github/workflows/documentation.yml#L16

templates are set here: https://github.com/NOAA-GFDL/fre-cli/blob/28908cb257c403062cbd7f6e14fa71eb6a0b28cb/docs/conf.py#L27C1-L28C1 we can set the template html_theme to sphinx_rtd_theme instead, but this breaks for the same reason

To Reproduce run a documentation workflow- see https://github.com/NOAA-GFDL/fre-cli/actions/runs/9912991769/job/27518230011

Expected behavior documentation being successfully built

Additional context this is a tracking issue- these templates and sphinx are out of our hands. The current hot fix is to pin sphinx to version 7.3.7 and earlier. 7.3.7 is last working installed version of sphinx for the workflow

ilaflott commented 1 month ago

This is also a tracking issue. Reopening and linking #148.

ilaflott commented 1 month ago

closing as of #148. this issue will be re-opened if this problem comes back up again. I am noticing a pattern...