Feat/improve doc build logic #502
Conversation
for more information, see https://pre-commit.ci
github-actions
bot
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
doc/source/conf.py
Outdated
| DOWNLOAD_FILES_DIR.mkdir(exist_ok=True) | ||
|
|
||
| for file_path in ZIPPED_FILES_DIR.glob("*"): | ||
| EXAMPLES = { |
There was a problem hiding this comment.
why using all caps for variables like examples, source_dir etc?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Thanks! Implemented your suggestions.
moe-ad
force-pushed
the
feat/improve-doc-build-logic
branch
from
a0d4a66
to
fef5eb5
Compare
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