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

Temp fix to autodoc generation timeout problem #265

Merged
merged 1 commit into from
Feb 10, 2023

Conversation

AhmetNSimsek
Copy link
Collaborator

Newly added voi features increase the doc generation time significantly. Removing voi-feature example from 03-000 to as a temporary fix to be able to produce docs.

@xgui3783
Copy link
Member

It seems 44f5eb4 whilst attempting to address the issue, did not completely address the issue.

see failed build at https://readthedocs.org/projects/siibra-python/builds/19431779/

@xgui3783
Copy link
Member

I think we can tentatively solve the issue by merging this PR.

However, build time & memory issue will continue to haunt us in the future, when/if we add more to sphinx gallery.

To solve this one and for all, I wonder if we can use a dedicated runner to:

  • run the examples (currently run by github action)
  • build sphinx docs (currently run by RTD)

@xgui3783
Copy link
Member

@AhmetNSimsek can you perhaps merge this and add as an issue that the sphinx gallery building should be addressed, with an important tag?

@AhmetNSimsek AhmetNSimsek merged commit f43192d into main Feb 10, 2023
@AhmetNSimsek AhmetNSimsek deleted the remove_voi_feat_example branch February 10, 2023 10:09
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