Skip to content

Commit

Permalink
Updated sphinx theme (#106)
Browse files Browse the repository at this point in the history
  • Loading branch information
rashidnhm committed Aug 24, 2022
1 parent fd699c1 commit f0dca9b
Show file tree
Hide file tree
Showing 27 changed files with 154 additions and 5,141 deletions.
Binary file modified doc/_static/favicon.ico
Binary file not shown.
Binary file added doc/_static/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 80 additions & 0 deletions doc/_static/pennylane.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
121 changes: 73 additions & 48 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -168,14 +168,6 @@
# 'donate.html',
# ]
# }
html_sidebars = {
"**": [
"logo-text.html",
"searchbox.html",
"globaltoc.html",
# 'sourcelink.html'
]
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down Expand Up @@ -227,52 +219,85 @@
htmlhelp_basename = "PennyLane-Forestdoc"

# # -- Xanadu theme ---------------------------------------------------------
html_theme = 'xanadu_theme'
html_theme_path = ['.']
html_theme = 'xanadu'

html_sidebars = {
'**': [
'searchbox.html',
'globaltoc.html',
]
}

# Register the theme as an extension to generate a sitemap.xml
# extensions.append("guzzle_sphinx_theme")

# xanadu theme options (see theme.conf for more information)
html_theme_options = {

# Set the path to a special layout to include for the homepage
# "index_template": "special_index.html",

# Set the name of the project to appear in the left sidebar.
"project_nav_name": "PennyLane-Forest",

# Set your Disqus short name to enable comments
# "disqus_comments_shortname": "pennylane-1",

# Set you GA account ID to enable tracking
"google_analytics_account": "UA-130507810-1",

# Path to a touch icon
"touch_icon": "logo_new.png",

# Specify a base_url used to generate sitemap.xml links. If not
# specified, then no sitemap will be built.
# "base_url": ""

# Allow a separate homepage from the master_doc
# "homepage": "index",

# Allow the project link to be overriden to a custom URL.
# "projectlink": "http://myproject.url",

"large_toc": True,
# colors
"navigation_button": "#19b37b",
"navigation_button_hover": "#0e714d",
"toc_caption": "#19b37b",
"toc_hover": "#19b37b",
"table_header_bg": "#edf7f4",
"table_header_border": "#19b37b",
"download_button": "#19b37b",
# gallery options
# "github_repo": "PennyLaneAI/PennyLane",
# "gallery_dirs": "tutorials",
"navbar_logo_path": "_static/logo.png",
"navbar_wordmark_path": "_static/pennylane.svg",
# Specifying #19b37b is more correct but does not match the other PL websites.

"navbar_logo_colour": "#2d7c7f",

"navbar_home_link": "https://pennylane.ai",

"navbar_left_links": [
{
"name": "Quantum machine learning",
"href": "https://pennylane.ai/qml/",
},
{
"name": "Demos",
"href": "https://pennylane.ai/qml/demonstrations.html",
},
{
"name": "Install",
"href": "https://pennylane.ai/install.html",
},
{
"name": "Plugins",
"href": "https://pennylane.ai/plugins.html",
"active": True,
},
{
"name": "Documentation",
"href": "https://docs.pennylane.ai/",
},
{
"name": "Blog",
"href": "https://pennylane.ai/blog/",
}
],

"navbar_right_links": [
{
"name": "FAQ",
"href": "https://pennylane.ai/faq.html",
"icon": "fas fa-question",
},
{
"name": "Support",
"href": "https://discuss.pennylane.ai/",
"icon": "fab fa-discourse",
},
{
"name": "GitHub",
"href": "https://github.com/PennyLaneAI/pennylane-qiskit",
"icon": "fab fa-github",
}
],

"extra_copyrights": [
"TensorFlow, the TensorFlow logo, and any related marks are trademarks "
"of Google Inc."
],
"google_analytics_tracking_id": "UA-130507810-1",
"border_colour": "#19b37b",
"prev_next_button_colour": "#19b37b",
"prev_next_button_hover_colour": "#0e714d",
"table_header_background_colour": "#edf7f4",
"text_accent_colour": "#19b37b",
"toc_marker_colour": "#19b37b",
}

edit_on_github_project = 'PennyLaneAI/pennylane-forest'
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ pennylane
pyquil>=2.16,<2.28.3
sphinx-automodapi
pygments-github-lexers
xanadu-sphinx-theme==0.1.0
20 changes: 0 additions & 20 deletions doc/xanadu_theme/LICENSE

This file was deleted.

16 changes: 0 additions & 16 deletions doc/xanadu_theme/comments.html

This file was deleted.

74 changes: 0 additions & 74 deletions doc/xanadu_theme/footer.html

This file was deleted.

20 changes: 0 additions & 20 deletions doc/xanadu_theme/globaltoc.html

This file was deleted.

0 comments on commit f0dca9b

Please sign in to comment.