fix: remove unecessary _tket perfix in local docs build
#1721
Conversation
CalMacCQ
changed the title
_tket in the docs_tket in the docs
CalMacCQ
changed the title
_tket in the docs_tket in the docs
pytket/docs/build-docs.sh
Outdated
| @@ -3,6 +3,8 @@ cp -R pytket-docs-theming/quantinuum-sphinx . | |||
| cp pytket-docs-theming/conf.py . | |||
|
|
|||
| sphinx-build -b html . build -D html_title="pytket" | |||
| find build/ -type f -name "*.html" | xargs sed -e 's/pytket._tket/pytket/g' -i "" | |||
There was a problem hiding this comment.
slightly worried that these sed comands are not architecture independent. They work fine on my mac. Maybe this is a good reason to use a Makefile?
The website uses linux runners in C.I. so will make sure to use the linux syntax there and test that it works.
There was a problem hiding this comment.
Could also check the platform from within the shell script and perform a switch on that.
There was a problem hiding this comment.
Can confirm that this does not work on Linux.
Yes, happy to update the script to check the platform its running on and adjust the sed command accordingly. |
CalMacCQ
changed the title
_tket in the docs_tket perfix in local docs build
Now added some handling so that the build script should work on MacOS and Linux. I've tested locally Note that the webiste is already fixed. This script is only for local builds |
Description
Note that this only impacts the local build. The website build is already fixed and deployed.
Updating the build script to replace all of the refernce to the internal
_tketmodule. Previously this was done by commands in theMakefilebut this stopped working due to some previous changes.I've decided to remove the
Makefilefor now as it was unused. Instead I've put the sed replace in thebuild-docs.shscript.Related issues
closes #1719