Skip to content

Comments

Fix docs build pipeline#986

Merged
ErikBjare merged 2 commits intoAntonOsika:mainfrom
kristiankyvik:fix-docs-build-pipeline
Jan 23, 2024
Merged

Fix docs build pipeline#986
ErikBjare merged 2 commits intoAntonOsika:mainfrom
kristiankyvik:fix-docs-build-pipeline

Conversation

@kristiankyvik
Copy link
Collaborator

@kristiankyvik kristiankyvik commented Jan 23, 2024

This commit seems to have broken the build pipeline for the docs. The builds have been failing for the last 6 weeks.

I have tested my changes locally, and I can successfully build the docs. This PR should fix this issue. I also added the docs/core folder to the .gitignore as I noticed it was generated when building the documentation locally.

I am not entirely about how the docs are being built and deployed - is this done automatically? If so, how?

Thanks!

@ErikBjare
Copy link
Collaborator

ErikBjare commented Jan 23, 2024

Docs are built and served via readthedocs.org, I don't know who has access. Probably @AntonOsika or @ATheorell.

Build logs can be seen here: https://readthedocs.org/projects/gpt-engineer/builds/

A few weeks ago I updated a similar site built with readthedocs (which has recently updated their config format) and fixed it in this commit: ActivityWatch/docs@2c0ae72

Looks like a similar change might be needed here.

@kristiankyvik
Copy link
Collaborator Author

kristiankyvik commented Jan 23, 2024

Hi @ErikBjare,

Thanks for sharing the link. As far as I understand, docs/conf.py had an issue that is now fixed in this PR.

CleanShot 2024-01-23 at 14 25 08@2x

Link: https://readthedocs.org/projects/gpt-engineer/builds/23192321/

Based on this, I think that once we trigger the build, it should now run successfully. I am now able to build the docs locally without any issue.

@ErikBjare
Copy link
Collaborator

ErikBjare commented Jan 23, 2024

It's correct that you fixed that issue, but I think there may be more issues as the current .readthedocs.yml config file doesn't explicitly specify the install dependency step (unlike the fix in the above linked PR). I might be wrong, as the doc deps are apparently in docs/requirements.txt, which is specified in the config. (although should probably be changed to use poetry directly, with a docs dependency group)

This PR can be merged though, one step closer hopefully all that is needed :)

@ErikBjare ErikBjare merged commit d0c6de6 into AntonOsika:main Jan 23, 2024
@ErikBjare
Copy link
Collaborator

It did fix that particular issue, but more popped up.

I might do the poetry fix I suggested earlier straight away.

@ErikBjare
Copy link
Collaborator

I finished the job in #987, now builds successfully!

Thanks @kristiankyvik ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants