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

Add GitHub link roles in documentation #361

Merged
merged 4 commits into from
Sep 8, 2023
Merged

Add GitHub link roles in documentation #361

merged 4 commits into from
Sep 8, 2023

Conversation

btjanaka
Copy link
Member

@btjanaka btjanaka commented Sep 8, 2023

Description

Adds two Sphinx roles to make it easier to link to GitHub PRs and issues in the documentation. Examples are:

:pr:`123` -> Links to PR 123
:issue:`123` -> Links to issue 123

References:

TODO

  • Create extension
  • Replace links in history
  • Replace links in rest of code

Questions

Status

  • I have read the guidelines in
    CONTRIBUTING.md
  • I have formatted my code using yapf
  • I have tested my code by running pytest
  • I have linted my code with pylint
  • I have added a one-line description of my change to the changelog in
    HISTORY.md
  • This PR is ready to go

@btjanaka btjanaka merged commit 563ea2c into master Sep 8, 2023
17 checks passed
@btjanaka btjanaka deleted the gh-links branch September 8, 2023 04:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant