-
Notifications
You must be signed in to change notification settings - Fork 674
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
introduce conda-lock file for docs #4553
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4553 +/- ##
==========================================
- Coverage 58.92% 58.92% -0.01%
==========================================
Files 620 620
Lines 52432 52432
==========================================
- Hits 30896 30895 -1
- Misses 19071 19072 +1
Partials 2465 2465
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Signed-off-by: Niels Bantilan <[email protected]>
dc0ddbe
to
c522bf6
Compare
Signed-off-by: Niels Bantilan <[email protected]>
commands: | ||
- cat monodocs-environment.lock.yaml | ||
- mamba install -c conda-forge conda-lock | ||
- conda-lock install -p /home/docs/monodocs-env monodocs-environment.lock.yaml | ||
- conda info | ||
- conda env list | ||
- cat docs/conf.py | ||
- cd docs && /home/docs/monodocs-env/bin/python -m sphinx -T -E -b html -d docs/_build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thomasjpfan minor risk (IMO) is that builds.command
key is in beta and may change in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried a solution in https://github.com/thomasjpfan/conda-lock-sphinx-test, which works on readthedocs. It uses a noop.yml
to create a small environment and immediately overrides it with conda-lock
.
I wanted to configure it without the noop.yml
, but readthedocs fails to build without it.
As long as it works, I prefer the build.command
approach. If it breaks in the future, there is a workaround.
commands: | ||
- cat monodocs-environment.lock.yaml | ||
- mamba install -c conda-forge conda-lock | ||
- conda-lock install -p /home/docs/monodocs-env monodocs-environment.lock.yaml | ||
- conda info | ||
- conda env list | ||
- cat docs/conf.py | ||
- cd docs && /home/docs/monodocs-env/bin/python -m sphinx -T -E -b html -d docs/_build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried a solution in https://github.com/thomasjpfan/conda-lock-sphinx-test, which works on readthedocs. It uses a noop.yml
to create a small environment and immediately overrides it with conda-lock
.
I wanted to configure it without the noop.yml
, but readthedocs fails to build without it.
As long as it works, I prefer the build.command
approach. If it breaks in the future, there is a workaround.
* introduce conda-lock file for docs Signed-off-by: Niels Bantilan <[email protected]> * add back _version.py Signed-off-by: Niels Bantilan <[email protected]> --------- Signed-off-by: Niels Bantilan <[email protected]> Signed-off-by: Paul Dittamo <[email protected]>
Tracking issue
https://github.com/flyteorg/flyte/issues/
Why are the changes needed?
To pin docs building dependencies.
What changes were proposed in this pull request?
conda-lock
make command to create the conda-lock filebuild.commands
to customize the readthedocs build process: https://docs.readthedocs.io/en/stable/config-file/v2.html#build-commandsHow was this patch tested?
conda-lock
make command