-
Notifications
You must be signed in to change notification settings - Fork 48
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,12 +3,10 @@ Pytket Docs | |
# Clone repository | ||
|
||
``` | ||
[email protected]:CQCL/tket.git | ||
git clone git@github.com:CQCL/tket.git --recurse-submodules | ||
``` | ||
|
||
``` | ||
git submodule update --recursive --init | ||
``` | ||
# Move to docs directory | ||
|
||
``` | ||
cd pytket/docs | ||
|
@@ -19,13 +17,23 @@ cd pytket/docs | |
``` | ||
poetry install | ||
``` | ||
|
||
# Install pytket | ||
|
||
The pytket package is not installed as a poetry dependency so needs to be installed seperately | ||
|
||
``` | ||
poetry run pip install -U pytket | ||
``` | ||
You can install a pypi version as above or an editable wheel. | ||
|
||
# Build html | ||
|
||
``` | ||
poetry run make html | ||
poetry run bash ./build-docs.sh | ||
``` | ||
# Serve build | ||
# Serve built html locally | ||
|
||
``` | ||
npx serve ./build/html | ||
npx serve build | ||
``` |