CQCL / pytket-docs

User manual and example notebooks for the pytket quantum computing toolkit
https://docs.quantinuum.com/tket/user-guide/
Apache License 2.0
331 stars 90 forks source link

Install `ipykernel` in docs build and remove duplication #273

Closed CalMacCQ closed 11 months ago

CalMacCQ commented 11 months ago

Follows some discussion in #272

Changes

  1. Installs ipykernel in build-manual script.

  2. Removed the copying of the manual/build directory into the docs/manual directory. I've also removed the docs/manual from .gitignore.

A question

Wouldn't it be simpler if the check-manual workflow used the build-manual script directly? We have essentially the same build commands in multiple places.

cqc-alec commented 11 months ago

Follows some discussion in #272

Changes

1. Installs `ipykernel` in `build-manual` script.

2. Removed the copying of the `manual/build` directory into the `docs/manual` directory. I've also removed the `docs/manual` from `.gitignore`.

A question

Wouldn't it be simpler if the check-manual workflow used the build-manual script directly? We have essentially the same build commands in multiple places.

Seems reasonable yes.

CalMacCQ commented 11 months ago

Okay I can make this change in a separate PR.