iqm-finland / KQCircuits

KLayout Python library for integrated quantum circuit design.
GNU General Public License v3.0
126 stars 71 forks source link

Removal of 'Edit on Github' link for API pages of KQC documentation - Fixes #92 #93

Closed f-martini closed 1 month ago

f-martini commented 1 month ago

ISSUE

The API documentation pages are automatically generated by sphinx. Despite not having a documentation "source" the same way hand-written documentation pages have, sphinx still renders a link to the associated non-existent repo page.
Such link has to be removed only for the API-related documentation pages.

SOLUTION

Added docs/_templates/breadcrumbs.html, as suggested in this post, in order to overwrite the custom sphinx theme.

Changes: Whenever :github_url: hide metadata is added at the top of a .rst file, breadcrumbs are not rendered. :github_url: hide has been added to the top of each template file responsible for the generation of the API docs.
A new line has been forced by adding {{"\n"}} to avoid the added static text interfering with header generation.

Fixes #92

cla-bot[bot] commented 1 month ago

Thank you for your pull request and welcome to our community.

We require contributors to sign our Contributor License Agreement (CLA), and it seems that the following contributors have not yet signed it: @f-martini.

In order for us to review and merge your code, please sign the CLA at meetiqm.com.

Once you have signed the CLA, write a comment here and we'll verify. Please note that it may take some time for us to verify it.

qpavsmi commented 1 month ago

Thank you for your pull request and welcome to our community.

We require contributors to sign our Contributor License Agreement (CLA), and it seems that the following contributors have not yet signed it: @f-martini.

In order for us to review and merge your code, please sign the CLA at meetiqm.com.

Once you have signed the CLA, write a comment here and we'll verify. Please note that it may take some time for us to verify it.

You don't need to sign the CLA again, this warning should go away eventually

qpavsmi commented 1 month ago

Seems that your CLA form somehow didn't get through, could you resubmit again and respond to this comment after you do so? https://www.meetiqm.com/iqm-individual-contributor-license-agreement

f-martini commented 1 month ago

Seems that your CLA form somehow didn't get through, could you resubmit again and respond to this comment after you do so? https://www.meetiqm.com/iqm-individual-contributor-license-agreement

I've just resubmitted it, let me know if you have received it. (I got the confirmation message on IQM web page btw)

qpavsmi commented 1 month ago

@cla-bot check

cla-bot[bot] commented 1 month ago

The cla-bot has been summoned, and re-checked this pull request!