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 release documentation github action #3844

Merged
merged 1 commit into from
Nov 7, 2023

Conversation

SMoraisAnsys
Copy link
Collaborator

No description provided.

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@SMoraisAnsys SMoraisAnsys force-pushed the ci/fix_release_documentation branch 2 times, most recently from 8868ef4 to 6193406 Compare November 3, 2023 16:10
@SMoraisAnsys SMoraisAnsys force-pushed the ci/fix_release_documentation branch 3 times, most recently from 668389d to 6ea5d17 Compare November 6, 2023 22:26
@SMoraisAnsys SMoraisAnsys changed the title WIP: Fix release documentation github action Fix release documentation github action Nov 6, 2023
@SMoraisAnsys SMoraisAnsys marked this pull request as ready for review November 6, 2023 22:27
@github-actions github-actions bot added documentation maintenance Package and maintenance related labels Nov 6, 2023
Problem
Building the full documentation with sphynx leads to the generation
of a .doctree directory. This directory is composed of a file
environment.pickle which has size > 100 Mb. Thus, the upload step of
the full documentation workflow fails due to the size of such file (git
does not allow files of > 100 Mb without using lfs).

Solution
Since the .doctree directory should not be versioned at all, we had a
build-finished event to delete to .doctree directory after the
documentation build.
Copy link

codecov bot commented Nov 6, 2023

Codecov Report

Merging #3844 (1865007) into main (6ce7943) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3844   +/-   ##
=======================================
  Coverage   81.13%   81.13%           
=======================================
  Files         180      180           
  Lines       62291    62291           
=======================================
+ Hits        50540    50541    +1     
+ Misses      11751    11750    -1     

Copy link
Member

@Samuelopez-ansys Samuelopez-ansys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you @SMoraisAnsys

@Samuelopez-ansys Samuelopez-ansys merged commit db50f96 into main Nov 7, 2023
12 checks passed
@Samuelopez-ansys Samuelopez-ansys deleted the ci/fix_release_documentation branch November 7, 2023 09:46
SMoraisAnsys added a commit that referenced this pull request Mar 13, 2024
Note: Now we leverage the doctree to create the PDF file after
the HTML file. The doctree is then deleted to avoid the issue
we had with the upload step

Related to: #3844
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants