readthedocs is 5 months out of date

[adcroft]

It looks like the last successful build of the documentation on readthedocs was on Sept 18 . I see that the NCAR branch last successfully compiled on Nov 19. The different dates make me wonder if this was a change on our part, rather than in the readthedocs system?

[marshallward]

We may want to use a more strict documentation test after this is fixed.

[andrew-c-ross]

Looks like it breaks on MOM_ann, possibly this invalid latex equation (3 $s):

MOM6/src/framework/MOM_ANN.F90

Line 726 in d2f562a

!! $\f$A_{l,j,i}\f$ are a rectangular matrix of weights for each layer, and \f$x_{l-1,i}\f$ are the outputs

There's a newer breakage that I think we were able to fix by adding setuptools<82.0.0 to the requirements.txt (https://github.com/NOAA-GFDL/CEFI-regional-MOM6/pull/262/changes). This will probably break again if the read the docs config is upgraded past python 3.11 though.

[andrew-c-ross]

The build got a lot farther, but still failed. I was wondering if Read the Docs would allow that external image

MOM6/src/framework/MOM_ANN.F90

Line 734 in 6aa65c6

!! \image html https://upload.wikimedia.org/wikipedia/commons/4/46/Colored_neural_network.svg

and I'm guessing that's the problem. Note the exception is on visit_image.

reading sources... [ 15%] api/generated/modules/mom_ann 

[...]

Exception occurred:
  File "/home/docs/checkouts/readthedocs.org/user_builds/mom6/envs/dev-gfdl/lib/python3.11/site-packages/sphinxcontrib/autodoc_doxygen/xmlutils.py", line 476, in visit_image
    if len(node.text.strip()):
           ^^^^^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'strip'