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

Avoid publishing doctrees files from Sphinx to prevent errors #93

Closed
d33bs opened this issue Sep 13, 2024 · 1 comment · Fixed by #94 or #95
Closed

Avoid publishing doctrees files from Sphinx to prevent errors #93

d33bs opened this issue Sep 13, 2024 · 1 comment · Fixed by #94 or #95
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@d33bs
Copy link
Member

d33bs commented Sep 13, 2024

We ran into an error regarding the size of the jump_umap_analysis_with_cosmicqc.doctree when building and attempting to deploy the docsite (see https://github.com/WayScience/coSMicQC/actions/runs/10839957924/job/30081358345). We can work around this by slightly reducing the notebook size (likely by moving to an exported image over interactive plot for one of the UMAP scatter plots).

According to the error the file sits at 105.31 MB, we need to remain under 100 MB to avoid the error.

@d33bs d33bs added bug Something isn't working documentation Improvements or additions to documentation labels Sep 13, 2024
@d33bs d33bs changed the title Reduce size of example JUMP UMAP notebook to avoid git issues with docs publishing Avoid publishing doctrees files from Sphinx to prevent errors Sep 13, 2024
@d33bs
Copy link
Member Author

d33bs commented Sep 13, 2024

I found that this was primarily caused by doctree files which are intermediary data required for building HTML documents.

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