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

Deploy docs to github pages #500

Closed
wants to merge 1 commit into from
Closed

Conversation

mmore500
Copy link
Member

@mmore500 mmore500 commented Dec 8, 2023

Our ReadTheDocs build is consistently timing out, we asked for more time before but it looks like we've been set back to ~20 min build limit... let's try self-hosting via GH Pages

@mmore500 mmore500 force-pushed the deploy-docs-githubpages branch from 9a0a031 to 7b14993 Compare December 8, 2023 21:10
@emilydolson
Copy link
Collaborator

I had a docs fix a while ago that drastically cut build time and put it well within the range of RTD (it took like 5 minutes). Did it maybe get lost in the shuffle? The main contribution was dropping Breathe, which doesn't actually do that much for us.

@mmore500
Copy link
Member Author

mmore500 commented Dec 8, 2023 via email

@mmore500
Copy link
Member Author

mmore500 commented Dec 8, 2023

Would I just remove breathe here in conf.py?

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.mathjax',
    'sphinx.ext.todo',
    'sphinx_rtd_theme',
    'breathe',
    'exhale',
    'myst_parser',
]

Copy link

codecov bot commented Dec 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (64460d9) 77.56% compared to head (d222c41) 77.53%.
Report is 1052 commits behind head on master.

❗ Current head d222c41 differs from pull request most recent head ba47d6b. Consider uploading reports for the commit ba47d6b to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #500      +/-   ##
==========================================
- Coverage   77.56%   77.53%   -0.04%     
==========================================
  Files         334      332       -2     
  Lines       39631    39575      -56     
==========================================
- Hits        30740    30683      -57     
- Misses       8891     8892       +1     

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

@mmore500
Copy link
Member Author

mmore500 commented Dec 8, 2023

Works! Documentation is now also showing up at https://devosoft.github.io/Empirical/

@mmore500 mmore500 force-pushed the deploy-docs-githubpages branch from d222c41 to ba47d6b Compare December 12, 2023 00:19
@mmore500
Copy link
Member Author

👍 re-merging fixed the docs on master, closing this for now

@mmore500 mmore500 closed this Dec 12, 2023
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