CQCL / hugr

Hierarchical Unified Graph Representation
https://crates.io/crates/hugr
Apache License 2.0
15 stars 4 forks source link

docs(hugr-py): build and publish docs #1253

Closed ss2165 closed 2 days ago

ss2165 commented 3 days ago

Closes #1215

Will build and publish for main branch + every tagged version with docs (currently none), using sphinx-multiversion

With multiple versions looks like:

image

Will follow-up with a PR adding links to readme etc. once I've seen the workflow succeeds.

codecov[bot] commented 3 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.99%. Comparing base (8f08b8c) to head (4d9efd8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #1253 +/- ## ======================================= Coverage 86.98% 86.99% ======================================= Files 102 102 Lines 19108 19111 +3 Branches 17015 17015 ======================================= + Hits 16622 16625 +3 Misses 1709 1709 Partials 777 777 ``` | [Flag](https://app.codecov.io/gh/CQCL/hugr/pull/1253/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CQCL) | Coverage Δ | | |---|---|---| | [python](https://app.codecov.io/gh/CQCL/hugr/pull/1253/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CQCL) | `91.17% <100.00%> (+0.01%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=CQCL#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.