Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v2 BUG]: readthedocs latest doesn't successfully build from main branch #828

Closed
Rhys-McAlister opened this issue Apr 23, 2024 · 5 comments
Labels
bug Something isn't working
Milestone

Comments

@Rhys-McAlister
Copy link

As title implies, the url to the docs in the new readme links to the old docs.

@Rhys-McAlister Rhys-McAlister added bug Something isn't working v1-wontfix issues that will not be fixed in time for the final stable v1.x release (v1.7) labels Apr 23, 2024
@Rhys-McAlister Rhys-McAlister changed the title [v1 BUG]: Docs url in main branch readme is wrong [v2 BUG]: Docs url in main branch readme is wrong Apr 23, 2024
@JacksonBurns
Copy link
Member

You have to change from latest to v2/dev: https://chemprop.readthedocs.io/en/v2-dev/

This will be the default in a day or so once we do the official release of v2.

@kevingreenman kevingreenman removed the v1-wontfix issues that will not be fixed in time for the final stable v1.x release (v1.7) label Apr 23, 2024
@kevingreenman
Copy link
Member

kevingreenman commented Apr 23, 2024

This should have been fixed by updating our Read the Docs settings ("Admin" > "Settings" > "Default branch") from --------- to main, but the build fails. I made a separate version of the docs that points to main, and that build succeeds, even though it's the exact same code as the "latest" version that points to main. I can't figure out how to fix this right now. I've temporarily updated the links in our README and release notes to point to https://chemprop.readthedocs.io/en/main/ instead of https://chemprop.readthedocs.io/en/latest/ (which still shows the last successful build from master).

The only issue with this is that if someone tries to go to https://chemprop.readthedocs.io/, it will redirect to "latest". The same goes for redirects from https://chemprop.csail.mit.edu/.

We left a comment on a relevant RTD issue is here: readthedocs/readthedocs.org#7907

We opened a new RTD issue here: readthedocs/readthedocs.org#11321

@kevingreenman kevingreenman reopened this Apr 23, 2024
@kevingreenman kevingreenman changed the title [v2 BUG]: Docs url in main branch readme is wrong [v2 BUG]: readthedocs latest doesn't successfully build from main branch Apr 23, 2024
@kevingreenman kevingreenman added this to the v2.0.1 milestone Apr 23, 2024
@kevingreenman
Copy link
Member

I just filled out the support form at https://readthedocs.org/support/ since we haven't heard back on our issue in a couple weeks. If we still don't hear back, it might be worth temporarily upgrading our readthedocs membership (looks like the lowest tier is $5/month), because this allows us to set a priority level with our support requests, which would hopefully lead to faster responses.

@kevingreenman
Copy link
Member

As noted here, the problem seems to be the line autoapi_ignore = ["*test*", "*cli*"] in our docs/source/conf.py. The pattern *test* is too broad because it matches to latest, which is the name of the build. Thus, we get the error message No source files found in: /home/docs/checkouts/readthedocs.org/user_builds/chemprop/checkouts/latest.

@kevingreenman
Copy link
Member

This was fixed in the most recent build by changing from autoapi_ignore = ["*test*", "*cli*"] to autoapi_ignore = ["*/tests/*", "*/cli/*"].

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants