-
Notifications
You must be signed in to change notification settings - Fork 12
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
docs: add pytket-docs-theming
submodule
#392
Conversation
.github/workflows/build_and_test.yml
Outdated
@@ -80,6 +80,7 @@ jobs: | |||
if: (matrix.os == 'ubuntu-22.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' ) | |||
run: | | |||
cd docs && bash ./install.sh | |||
poetry run pip install ../. |
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.
Not sure if this is how I should be installing the pytket-qiskit version in this workflow.
Would it be better to install a .whl
directly?
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 think there should be a wheel available to install at this point.
Could you try something like below?
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry install $w ; done
Or if that is not working
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry run pip install $w ; done
pytket-docs-theming
submodule
.github/workflows/build_and_test.yml
Outdated
@@ -128,14 +132,16 @@ jobs: | |||
path: wheelhouse | |||
- name: Install pip, wheel | |||
run: pip install -U pip wheel | |||
- name: Install poetry | |||
run: pip install poetry | |||
- name: Install extension | |||
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do pip install $w ; done |
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'm not sure what do do with this line as I don't think the wheel is installed in the poetry env
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.
As above, I would replace this with:
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 have a few questions / suggestions.
I think it might be good to try a release candidate from this branch to check if this works?
.github/workflows/build_and_test.yml
Outdated
@@ -80,6 +80,7 @@ jobs: | |||
if: (matrix.os == 'ubuntu-22.04') && (github.event_name == 'pull_request' || github.event_name == 'schedule' ) | |||
run: | | |||
cd docs && bash ./install.sh | |||
poetry run pip install ../. |
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 think there should be a wheel available to install at this point.
Could you try something like below?
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry install $w ; done
Or if that is not working
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry run pip install $w ; done
.github/workflows/build_and_test.yml
Outdated
@@ -128,14 +132,16 @@ jobs: | |||
path: wheelhouse | |||
- name: Install pip, wheel | |||
run: pip install -U pip wheel | |||
- name: Install poetry | |||
run: pip install poetry | |||
- name: Install extension | |||
run: for w in `find wheelhouse/ -type f -name "*.whl"` ; do pip install $w ; done |
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.
As above, I would replace this with:
- name: Test building docs | ||
timeout-minutes: 20 | ||
timeout-minutes: 10 |
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.
Have you reduced the timeout on purpose?
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.
Yes, would you prefer I changed it back?
Description
Essentially a clone of CQCL/pytket-cutensornet#153 but for pytket-qiskit.
Using the pytket-docs-theming repo as a source of truth for the different extension modules.
Also took the oppurtunity to clean up the legacy docs build.
Added scripts for installing the docs dependencies and building the docs (b0b55c9). These scripts will not be used in the website build... Only in this repository.
My local build below
I note that theres a decent amount of duplication in the github workflows as the docs are built multiple times (see
docs.yml
andbuild_and_test.yml
. Should we update these at this point? Or should that be done at a later time?Related issues
CQCL/pytket-docs#360
Checklist