added missing variables (#24)

* added missing variables * updated CHANGELOG * Update README.rst * Update README.rst Co-authored-by: Josh Izaac <[email protected]> * Update xanadu_sphinx_theme/theme.conf Co-authored-by: Josh Izaac <[email protected]> * Update .github/CHANGELOG.md Co-authored-by: Josh Izaac <[email protected]> * Update README.rst Co-authored-by: Josh Izaac <[email protected]> * Update README.rst Co-authored-by: Josh Izaac <[email protected]> * Update xanadu_sphinx_theme/theme.conf Co-authored-by: Josh Izaac <[email protected]> * updated version for release Co-authored-by: Josh Izaac <[email protected]>
XanaduAI · Oct 12, 2022 · fb06975 · fb06975
1 parent 3555445
commit fb06975
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 3 deletions.
diff --git a/.github/CHANGELOG.md b/.github/CHANGELOG.md
@@ -2,15 +2,19 @@
 
 ### 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)
+
 * Fixed a bug where author bio photos would appear squished. [#25](https://github.com/XanaduAI/xanadu-sphinx-theme/pull/25)
 
 ### Contributors
 
 This release contains contributions from (in alphabetical order):
 
+[Lucas Silbernagel](https://github.com/LucasSilbernagel)
 [Josh Izaac](https://github.com/josh146).
 
-## Release 0.3.1 (current release)
+## Release 0.3.1
 
 ### Improvements
 

diff --git a/README.rst b/README.rst
@@ -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",
@@ -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
 --------------
@@ -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
diff --git a/xanadu_sphinx_theme/_version.py b/xanadu_sphinx_theme/_version.py
@@ -3,4 +3,4 @@
 using the following format: <major>.<minor>.<patch>[-<pre-release>].
 """
 
-__version__ = "0.4.0-dev"
+__version__ = "0.3.2"
diff --git a/xanadu_sphinx_theme/theme.conf b/xanadu_sphinx_theme/theme.conf
@@ -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