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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

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.

@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 (28fa37e) to head (fef5eb5).
Report is 2 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 marked this pull request as ready for review November 28, 2024 11:55
DOWNLOAD_FILES_DIR.mkdir(exist_ok=True)

for file_path in ZIPPED_FILES_DIR.glob("*"):
EXAMPLES = {
Copy link
Contributor

Choose a reason for hiding this comment

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

why using all caps for variables like examples, source_dir etc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is because those more or less do not change, like constants.
If you prefer, I can move examples to the top of the file and pass it as an argument to the function instead.

Copy link
Contributor

Choose a reason for hiding this comment

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

SOURCE_DIR should just be a lower case variable, it depends on the input app, it's not a constant.
Regarding EXAMPLES, either you move it outside of the function as a constant or you make it lower case inside the function. Either is fine with me.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Implemented your suggestions.

@moe-ad moe-ad force-pushed the feat/improve-doc-build-logic branch from a0d4a66 to fef5eb5 Compare December 1, 2024 14:41
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