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

Fix docs builds and prohibit warnings again #4940

Closed
unito-bot opened this issue May 21, 2024 · 2 comments · Fixed by #4964
Closed

Fix docs builds and prohibit warnings again #4940

unito-bot opened this issue May 21, 2024 · 2 comments · Fixed by #4964
Assignees

Comments

@unito-bot
Copy link

We had to allow warnings in the doc build to get through the rest of CI for the release, but we should fix whatever the underlying problem was and turn the no-warnings check back on.

┆Issue is synchronized with this Jira Story
┆Issue Number: TOIL-1573

@adamnovak
Copy link
Member

We turned them off in 6a1bbbd

@adamnovak
Copy link
Member

The docs fail to build with sphinx-autoapi 3.1 due to warnings like:

/builds/databiosphere/toil/docs/autoapi/toil/utils/toilStats/index.rst:: WARNING: more than one target found for cross-reference 'TemporaryID': toil.job.TemporaryID, toil.jobStores.fileJobStore.TemporaryID, toil.leader.TemporaryID, toil.test.jobStores.jobStoreTest.TemporaryID, toil.test.src.jobDescriptionTest.TemporaryID, toil.wdl.wdltoil.TemporaryID

The docs see many duplicate copies of things imported by name.

On sphinx-autoapi 3.0 we do not have this problem.

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 a pull request may close this issue.

2 participants