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.

Sign up for GitHub

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
merged 11 commits into from
Oct 12, 2022
Merged

added missing variables #24

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e38255f
added missing variables
Oct 11, 2022
79a84e9
updated CHANGELOG
Oct 11, 2022
a74780e
Update README.rst
josh146 Oct 11, 2022
3daa1aa
Update README.rst
LucasSilbernagel Oct 11, 2022
c1b232d
Update xanadu_sphinx_theme/theme.conf
LucasSilbernagel Oct 11, 2022
0fffe46
Update .github/CHANGELOG.md
LucasSilbernagel Oct 11, 2022
f3b448f
Update README.rst
LucasSilbernagel Oct 11, 2022
660b366
Update README.rst
LucasSilbernagel Oct 11, 2022
3aedd0a
Update xanadu_sphinx_theme/theme.conf
LucasSilbernagel Oct 11, 2022
b718fc5
updated version for release
Oct 12, 2022
40bef95
Merge branch 'master' into sc-27275-view-on-github-links-broken-on-qm…
josh146 Oct 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions .github/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
## Release 0.4.0 (development release)
## Release 0.3.2

### Bug fixes

* Added missing variables: `github_repo` and `gallery_dirs` to address the View on GitHub link not working for demos.
[#24](https://github.com/XanaduAI/xanadu-sphinx-theme/pull/24)

### Contributors

This release contains contributions from (in alphabetical order):

## Release 0.3.1 (current release)
[Lucas Silbernagel](https://github.com/LucasSilbernagel)

## Release 0.3.1

### Improvements

Expand Down
8 changes: 7 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Once installed, simply add or modify the following variables of your Sphinx

"navbar_home_link": "https://example.com",

"github_repo": "",
"navbar_left_links": [
{
"name": "Tutorials",
Expand Down Expand Up @@ -119,6 +120,11 @@ the ``html_theme_options`` dictionary in your ``conf.py`` file.

``google_analytics_tracking_id``
Google Analytics tracking ID to enable website analytics.

``github_repo``
The GitHub organization and repository associated with the documentation. E.g.,
for a GitHub repository https://github.com/Organization/repo, this should be
``"github_repo": "Organization/repo"``.

Navigation Bar
--------------
Expand Down Expand Up @@ -392,4 +398,4 @@ License
The Xanadu Sphinx Theme is **free** and **open source**, released under the
`Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

.. license-end-inclusion-marker-do-not-remove
.. license-end-inclusion-marker-do-not-remove
6 changes: 6 additions & 0 deletions xanadu_sphinx_theme/theme.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ google_analytics_tracking_id =
# List of extra copyright notices to place in the footer.
extra_copyrights =

# GitHub organization and repository name of associated GitHub repo.
# Used to ensure that 'View on GitHub' buttons work.
github_repo =
# Path where to save gallery generated examples
gallery_dirs =

# Specify the title and description of the About section in the footer
footer_about =
# Provide lists of links to display in the footer
Expand Down