Skip to content

Commit

Permalink
Update README.md (#1625)
Browse files Browse the repository at this point in the history
  • Loading branch information
CalMacCQ authored Oct 24, 2024
1 parent b1f15f9 commit 83c0099
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions pytket/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```

0 comments on commit 83c0099

Please sign in to comment.