Why is Read the Docs Failing?

[catherine-martlin]

I think a deeper dive into the process of building the documentation as seen here: https://media.readthedocs.org/pdf/docs/stable/docs.pdf#page=12&zoom=100,0,596
is needed.

Here is some info to keep track of what I'm running into re issues:

I'm trying to figure out the error on our read the docs build as seen here: https://readthedocs.org/projects/exoctk/builds/8114176/

I think it might be the same error discussed in this github issue, but they were supposed to have pushed a fix to it for the code that builds the docs that get hosted to the external webpage. I do think we need to ensure that the code that platform has ingested from git is the most up to date, but based on the error log I think it is.

We first see this fail error about 4 months ago (https://readthedocs.org/projects/exoctk/builds/7518335/) which is when that github error is talked about (readthedocs/readthedocs.org#4379).

Before that it was running similar git commands and instead failing further along with other issues that would likely be different now with my updates (an example is here: https://readthedocs.org/projects/exoctk/builds/7449900/). I'd love to talk about ideas to deal with this issue, as I'm not exactly sure how to tackle it. (edited)

[catherine-martlin]

Did our setup file change from setup.cfg to setup.py? When and why? What does that change mean besides a file name? [ Check the /docs/conf.py line 51!]

[catherine-martlin]

Double checking - a lot of changes need to happen to the conf.py file as the setup.py file is very different. Once those are done I think testing the format of the .rtd-environments.yml needs to be updated as it's also very out of date with the requirements in the setup.py file.

[catherine-martlin]

See PR #175 - Was able to get read the docs to build successfully!
Still need to complete further updates as the documents aren't building automatically yet, so the pages aren't filled out appropriately.

[catherine-martlin]

HAH. Finally building, now to update the automated document building portion.