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

docs: fix RTD timeout issue #3694

Merged
merged 8 commits into from
Apr 20, 2024
Merged

docs: fix RTD timeout issue #3694

merged 8 commits into from
Apr 20, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Apr 19, 2024

Currently, the readthedocs build is terminated due to time out after 30 minutes on the devel branch, since it also builds other formats

  1. Per https://docs.readthedocs.io/en/stable/guides/build-using-too-many-resources.html#document-python-modules-api-statically, autoapi might be faster.
  2. Turn off epub and htmlzip. I don't think some one uses them.

image

Currently the readthedocs build is timeout. Per https://docs.readthedocs.io/en/stable/guides/build-using-too-many-resources.html#document-python-modules-api-statically, autoapi might be faster. Let's try it. If the problem is not resolved, I may turn off the PDF build or request more time limit.

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@github-actions github-actions bot added the Docs label Apr 19, 2024
doc/conf.py Fixed Show resolved Hide resolved
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.89%. Comparing base (13202cc) to head (66bf641).

Additional details and impacted files
@@           Coverage Diff           @@
##            devel    #3694   +/-   ##
=======================================
  Coverage   81.89%   81.89%           
=======================================
  Files         508      508           
  Lines       46585    46585           
  Branches     2952     2952           
=======================================
  Hits        38152    38152           
  Misses       7540     7540           
  Partials      893      893           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

njzjz added 4 commits April 19, 2024 17:19
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz
Copy link
Member Author

njzjz commented Apr 19, 2024

Oh, I found we don't only build PDF but also build epub, single HTML. I don't think they are useful...

@njzjz njzjz changed the title docs: replace apidoc with autoapi docs: fix RTD timeout issue Apr 19, 2024
njzjz added 2 commits April 19, 2024 17:49
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
@njzjz njzjz requested a review from wanghan-iapcm April 19, 2024 21:52
@wanghan-iapcm wanghan-iapcm added this pull request to the merge queue Apr 20, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 20, 2024
@njzjz njzjz added this pull request to the merge queue Apr 20, 2024
Merged via the queue into deepmodeling:devel with commit 41dc57e Apr 20, 2024
49 checks passed
@njzjz njzjz deleted the docs-autoapi branch April 20, 2024 03:25
mtaillefumier pushed a commit to mtaillefumier/deepmd-kit that referenced this pull request Sep 18, 2024
Currently, the readthedocs build is terminated due to time out after 30
minutes on the devel branch, since it also builds other formats

1. Per
https://docs.readthedocs.io/en/stable/guides/build-using-too-many-resources.html#document-python-modules-api-statically,
autoapi might be faster.
2. Turn off epub and htmlzip. I don't think some one uses them.


![image](https://github.com/deepmodeling/deepmd-kit/assets/9496702/00274d6d-99c4-41cf-ba02-52cf287ea3a3)

---------

Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants