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.

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

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

Merged
merged 2 commits into from
May 31, 2024

Conversation

f-martini
Copy link
Contributor

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

Copy link

cla-bot bot commented May 30, 2024

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
Copy link
Contributor

qpavsmi commented May 30, 2024

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
Copy link
Contributor

qpavsmi commented May 30, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor

qpavsmi commented May 30, 2024

@cla-bot check

@cla-bot cla-bot bot added the cla-signed label May 30, 2024
Copy link

cla-bot bot commented May 30, 2024

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

Copy link
Contributor

@qpavsmi qpavsmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works well and a very concise implementation! I will proceed with merging this to our main branch! Thanks for your contribution!

@qpavsmi qpavsmi merged commit 08d7d8a into iqm-finland:main May 31, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken Edit on Github link for API pages of KQC documentation
2 participants