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

Jump to bottom

Add docstrings and doctests to Python builder code #1214

Closed
Tracked by #486
ss2165 opened this issue Jun 21, 2024 · 0 comments · Fixed by #1231
Closed
Tracked by #486

Add docstrings and doctests to Python builder code #1214

ss2165 opened this issue Jun 21, 2024 · 0 comments · Fixed by #1231
Assignees
@ss2165

Comments

@ss2165
Copy link
Member

ss2165 commented Jun 21, 2024

No description provided.

@ss2165 ss2165 mentioned this issue Jun 21, 2024
Closed
14 tasks
@ss2165 ss2165 self-assigned this Jun 21, 2024
This was referenced Jun 21, 2024
Closed
Merged
github-merge-queue bot pushed a commit that referenced this issue Jul 2, 2024
@ss2165 @acl-cqc @cqc-alec
docs(hugr-py): docstrings for builder (#1231)
3e4ac18 
first commit just copies in the docs building infrastructure from guppy,
the rest add docstrings by file. There are some minor refactor commits
towards the end that I couldn't untangle from the docs.

Closes #1214 

To build docs:

```bash
cd hugr-py
poetry install --with=docs
cd docs
./build.sh
open build/api-docs/index.html
```

---------

Co-authored-by: Alan Lawrence <[email protected]>
Co-authored-by: Alec Edgington <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ss2165 ss2165

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(hugr-py): docstrings for builder CQCL/hugr
1 participant
@ss2165