Skip to content

Commit 662fcfa

Browse files
authored
docs: fix link for RemoveBarriers pass, update docs build scripts (#457)
* docs: fix link for `RemoveBarriers` pass * black formatting * update docs submodule * replace _tket links in build-docs script
1 parent 8499fa7 commit 662fcfa

File tree

4 files changed

+11
-4
lines changed

4 files changed

+11
-4
lines changed

docs/build-docs.sh

+8
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ sed -i '' 's#CQCL/tket#CQCL/'$EXTENSION_NAME'#' _static/nav-config.js
1515
# Build the docs. Ensure we have the correct project title.
1616
sphinx-build -b html -D html_title="$EXTENSION_NAME" . build
1717

18+
if [[ "$OSTYPE" == "darwin"* ]]; then
19+
find build/ -type f -name "*.html" | xargs sed -e 's/pytket._tket/pytket/g' -i ""
20+
sed -i '' 's/pytket._tket/pytket/g' build/searchindex.js
21+
else
22+
find build/ -type f -name "*.html" | xargs sed -i 's/pytket._tket/pytket/g'
23+
sed -i 's/pytket._tket/pytket/g' build/searchindex.js
24+
fi
25+
1826
# Remove copied files. This ensures reusability.
1927
rm -r _static
2028
rm -r quantinuum-sphinx

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ Every {py:class}`~pytket.backends.backend.Backend` in pytket has its own {py:met
208208
* - [AutoRebase [2]](inv:#*.AutoRebase)
209209
- [SynthesiseTket](inv:#*.SynthesiseTket)
210210
- [FullPeepholeOptimise](inv:#*.passes.FullPeepholeOptimise)
211-
- [RemoveBarriers](inv:#*pytket.passes.RemoveBarriers)
211+
- [RemoveBarriers](inv:#*pytket._tket.passes.RemoveBarriers)
212212
* - LightSabre [3]
213213
- LightSabre [3]
214214
- LightSabre [3]

pytket/extensions/qiskit/qiskit_convert.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313
# limitations under the License.
1414

1515

16-
"""Methods to allow conversion between Qiskit and pytket circuit classes
17-
"""
16+
"""Methods to allow conversion between Qiskit and pytket circuit classes"""
1817
import warnings
1918
from collections import defaultdict
2019
from collections.abc import Iterable

0 commit comments

Comments
 (0)