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 support for the QML repo #14

Merged
merged 35 commits into from
Sep 10, 2022
Merged

Add support for the QML repo #14

merged 35 commits into from
Sep 10, 2022

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Sep 2, 2022

  • Add a new .. bio:: directive, which supports inserting author bios.

  • Add support for Sphinx Gallery.

  • Adds a new option toc_global which allows the left-hand global TOC sidebar to be disabled.

For example: https://xanadu-sphinx-theme--14.org.readthedocs.build/en/14/gallery/tutorial_demo.html

See PennyLaneAI/qml#561 for a version of the QML website that is built using this branch of the XST theme (deployment https://qml-build-previews.pennylane.ai/pull_request_build_preview/561/index.html)

@github-actions
Copy link
Contributor

github-actions bot commented Sep 2, 2022

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.

Base automatically changed from docs to master September 2, 2022 17:08
@@ -453,6 +453,38 @@ div.sphinxsidebar .sidebar-toc ul ul {
padding: 0;
}

.sidebar-toc.dropdown-menu {
Copy link
Member Author

Choose a reason for hiding this comment

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

Most of the additions below are CSS from the QML repo that weren't reflected here.

Copy link
Collaborator

@Mandrenkov Mandrenkov left a comment

Choose a reason for hiding this comment

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

Looks great! ⭐

Do you know why the Overview link not showing up in the dropdown? Is that intentional?

Screen Shot 2022-09-09 at 5 54 52 PM

.github/CHANGELOG.md Outdated Show resolved Hide resolved
doc/requirements.txt Outdated Show resolved Hide resolved
xanadu_sphinx_theme/directives/bio.py Outdated Show resolved Hide resolved
doc/conf.py Show resolved Hide resolved
xanadu_sphinx_theme/header.html Show resolved Hide resolved
xanadu_sphinx_theme/search.html Outdated Show resolved Hide resolved
xanadu_sphinx_theme/theme.conf Outdated Show resolved Hide resolved
xanadu_sphinx_theme/static/xanadu.css_t Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
doc/conf.py Outdated Show resolved Hide resolved
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
@josh146
Copy link
Member Author

josh146 commented Sep 10, 2022

Do you know why the Overview link not showing up in the dropdown? Is that intentional?

Yep this was intentional, since I am assuming that the Documentation home page will be linked by clicking the main navbar button the hover TOC comes out of - making the 'Overview' item redundant.

Another reason I disabled it is that I couldn't get it to look correct in the hover menu, something about the CSS wasn't working 😆

@josh146 josh146 merged commit 7910287 into master Sep 10, 2022
@josh146 josh146 deleted the no-sidebar branch September 10, 2022 01:03
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

2 participants