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

Feat/improve doc build logic #502

Merged
merged 6 commits into from
Dec 13, 2024
Merged

Conversation

moe-ad
Copy link
Contributor

@moe-ad moe-ad commented Nov 28, 2024

Description

This PR will close #501. Pre-build scripts are set up as hooks in conf.py and "sphinx-build ..." is being called directly in tox instead of "make ..."

Checklist

  • I have tested these changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have linked the issue(s) addressed by this PR if any.

@moe-ad moe-ad requested a review from jorgepiloto November 28, 2024 10:31
@github-actions github-actions bot added documentation Improvements or additions to documentation enhancement New features or code improvements labels Nov 28, 2024
Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.45%. Comparing base (b7f1e48) to head (f145ab1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #502   +/-   ##
=======================================
  Coverage   92.45%   92.45%           
=======================================
  Files          64       64           
  Lines        2599     2599           
=======================================
  Hits         2403     2403           
  Misses        196      196           

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

tox.ini Outdated Show resolved Hide resolved
Copy link
Member

@jorgepiloto jorgepiloto left a comment

Choose a reason for hiding this comment

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

Thanks, @moe-ad. Just left some minor comments.

@github-actions github-actions bot added the maintenance Package and maintenance related label Nov 28, 2024
@moe-ad moe-ad requested a review from jorgepiloto November 28, 2024 11:54
@moe-ad moe-ad marked this pull request as ready for review November 28, 2024 11:55
doc/source/conf.py Outdated Show resolved Hide resolved
@moe-ad moe-ad requested a review from FedericoNegri November 28, 2024 13:10
@moe-ad moe-ad force-pushed the feat/improve-doc-build-logic branch from a0d4a66 to fef5eb5 Compare December 1, 2024 14:41
@moe-ad moe-ad requested review from FedericoNegri and removed request for FedericoNegri December 4, 2024 13:35
Copy link
Contributor

@FedericoNegri FedericoNegri left a comment

Choose a reason for hiding this comment

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

Approved, but please wait to merge. We have some test failures on main that we need to fix before any additional change goes in.

@moe-ad
Copy link
Contributor Author

moe-ad commented Dec 8, 2024

Noted @FedericoNegri .

@FedericoNegri FedericoNegri merged commit 68cecde into main Dec 13, 2024
21 checks passed
@FedericoNegri FedericoNegri deleted the feat/improve-doc-build-logic branch December 13, 2024 08:40
@moe-ad moe-ad self-assigned this Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New features or code improvements maintenance Package and maintenance related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation build logic
3 participants