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.

Sign up for GitHub

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

fix: remove unecessary _tket perfix in local docs build #1721

Merged
merged 10 commits into from
Dec 13, 2024
Merged

fix: remove unecessary _tket perfix in local docs build #1721

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
243a4ba
update build script to replace _tket
CalMacCQ Dec 12, 2024
fc482a9
delete unused makefile
CalMacCQ Dec 12, 2024
e53859b
uncomment sed
CalMacCQ Dec 12, 2024
4832fa1
fix path for searchindex.js sed
CalMacCQ Dec 12, 2024
e6f30d6
final fix for search index replace
CalMacCQ Dec 12, 2024
82e7391
Merge branch 'main' into fix/docs_underscore
CalMacCQ Dec 12, 2024
712d12e
make shell script work for linux and mac
CalMacCQ Dec 13, 2024
887442b
uupdate script to align with website build
CalMacCQ Dec 13, 2024
78ee94a
minor edits
CalMacCQ Dec 13, 2024
7986cc8
fix comment
CalMacCQ Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions pytket/docs/Makefile
View file
Open in desktop

This file was deleted.

2 changes: 2 additions & 0 deletions pytket/docs/build-docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ""
Copy link
Contributor Author

@CalMacCQ CalMacCQ Dec 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also check the platform from within the shell script and perform a switch on that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can confirm that this does not work on Linux.

sed -i '' 's/pytket._tket/pytket/g' build/searchindex.js

# Remove copied files. This ensures reusability.
rm -r _static
Expand Down
Loading