search

iqm-finland / KQCircuits

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

Links to files in documentation #9

Closed nikosavola closed 2 years ago

nikosavola commented 2 years ago

The docs occasionally refer to specific files in repository, such as, this paragraph in Geometry from Klayout GUI:

Alternatively, run following macros in Klayout:

  • scripts/macros/export/export_ansys.lym
  • scripts/macros/export/export_sonnet.lym

It would be nice if these were links to the files in main on GitHub. The |GIT_CLONE_URL| substitution already exists, so it can probably be used to implement this.

divshacker commented 2 years ago

I would like to work on this issue. Please Assign me Thanks

jkotilahti commented 2 years ago

Thank you for offering to help with this @divshacker! I assigned you now.

Please note that in order for us to accept your pull requests you must sign the IQM Contributor License Agreement (https://github.com/iqm-finland/KQCircuits#contributing).

nikosavola commented 2 years ago

It would be nice if this was done automatically for strings that look like paths, or with some custom Sphinx directive like 

:github-link:`scripts/macros/export/export_ansys.lym`

The GitHub repo configurations exists already conf.py. So this wouldn't need hardcoding any repo URL either.

devanshj27 commented 2 years ago

I would like to work on this issue. Please Assign me Thanks

were you able to complete it? I am a beginner here, and i want to learn and implement, please guide me