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

added missing variables #24

Merged

Conversation

LucasSilbernagel
Copy link
Contributor

@LucasSilbernagel LucasSilbernagel commented Oct 11, 2022

Adds missing variables: github_link and gallery_dirs

@josh146 I don't really know what I'm doing with this, let me know if I missed anything or if there's anything else I can do to help.

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit .github/CHANGELOG.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name and GitHub username in the contributors section.

@Mandrenkov
Copy link
Collaborator

Have you tried building a local version of the e.g. PennyLane documentation using this version of the XST and confirmed that the expected behaviour is happening now, @LucasSilbernagel?

Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

Thanks @LucasSilbernagel! just two minor changes.

README.rst Outdated Show resolved Hide resolved
xanadu_sphinx_theme/theme.conf Outdated Show resolved Hide resolved
Copy link
Member

@josh146 josh146 left a comment

Choose a reason for hiding this comment

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

@LucasSilbernagel I just noticed that this variable is called github_repo here, not github_link:

var githubLink = "https://github.com/" + "{{ theme_github_repo }}" + "/blob/master/" + tutorialUrlArray.join("/") + ".py",

So a few suggested changes to correct this.

.github/CHANGELOG.md Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
xanadu_sphinx_theme/theme.conf Outdated Show resolved Hide resolved
LucasSilbernagel and others added 6 commits October 11, 2022 16:26
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
Co-authored-by: Josh Izaac <josh146@gmail.com>
@LucasSilbernagel
Copy link
Contributor Author

Have you tried building a local version of the e.g. PennyLane documentation using this version of the XST and confirmed that the expected behaviour is happening now, @LucasSilbernagel?

@Mandrenkov @josh146 are there instructions somewhere on how to do that?

@josh146
Copy link
Member

josh146 commented Oct 11, 2022

@LucasSilbernagel if you install this repository locally using pip (pip install -e .), then make html-norun on the QML website will use this branch.

@LucasSilbernagel
Copy link
Contributor Author

@LucasSilbernagel if you install this repository locally using pip (pip install -e .), then make html-norun on the QML website will use this branch.

Thanks @josh146 ! I think something still isn't right, the View on GitHub links still don't work.

@josh146
Copy link
Member

josh146 commented Oct 11, 2022

@LucasSilbernagel have you updated the qml/conf.py file to specify 'github_repo':'PennyLaneAI/qml'?

@LucasSilbernagel
Copy link
Contributor Author

LucasSilbernagel commented Oct 11, 2022

@LucasSilbernagel have you updated the qml/conf.py file to specify 'github_repo':'PennyLaneAI/qml'?

@josh146 Ah okay, that worked! Do I need to open a QML PR with that change?

@josh146
Copy link
Member

josh146 commented Oct 11, 2022

@LucasSilbernagel yes please 🙂 Note that it won't work until we make a new release of XST. Do you mind updating the xst/_version.py file to reflect 0.3.2, so that we can make a release?

@LucasSilbernagel
Copy link
Contributor Author

@josh146 version updated for release. Is there anything else we have to do here, or can this just be merged?

@josh146
Copy link
Member

josh146 commented Oct 12, 2022

Should be good to be merged @LucasSilbernagel :)

@LucasSilbernagel LucasSilbernagel merged commit fb06975 into master Oct 12, 2022
@LucasSilbernagel LucasSilbernagel deleted the sc-27275-view-on-github-links-broken-on-qml-demos branch October 12, 2022 13:58
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.

None yet

3 participants