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

Update documentation CI task to build local packages #110

Merged
merged 1 commit into from
Jan 19, 2024
Merged

Conversation

dnanuti
Copy link
Contributor

@dnanuti dnanuti commented Jan 18, 2024

Update documentation CI task to build local packages

Description

Build local packages to fix import issue in docs generation task

Additional context

We have previously removed hard-coded version number as part of #104. This broke the docs generation workflow:

Configuration error:
There is a programmable error in your configuration file:

Traceback (most recent call last):
  File "/home/runner/.local/lib/python3.10/site-packages/sphinx/config.py", line 358, in eval_config_file
    exec(code, namespace)  # NoQA: S102
  File "/home/runner/work/s3-connector-for-pytorch/s3-connector-for-pytorch/s3torchconnector/docs/conf.py", line 14, in <module>
    from s3torchconnector import __version__
ModuleNotFoundError: No module named 's3torchconnector'

We are resolving this by installing the local packages before generating the documentation.

Related items

#104 broke the docs generation task, this PR is fixing it.

Testing


By submitting this pull request, I confirm that my contribution is made under the terms of BSD 3-Clause License and I agree to the terms of the LICENSE.

To remove hardcoded version number and use the imported
one, we should build local packages to get the up-to-date
value.
@dnanuti dnanuti merged commit 329f9c5 into main Jan 19, 2024
19 checks passed
@dnanuti dnanuti deleted the feature/fix-docs branch January 19, 2024 09:07
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