Skip to content

Commit

Permalink
docs(style): Update documentation style and images
Browse files Browse the repository at this point in the history
The style of the documentation has been updated to match that of app.piquasso.com
  • Loading branch information
boldar99 committed Oct 29, 2023
1 parent fe76918 commit f3959de
Show file tree
Hide file tree
Showing 7 changed files with 91 additions and 5 deletions.
14 changes: 14 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
body[data-theme="dark"] div.nbinput.container div.input_area, .highlight {
border-color: #232d48!important;
}

div.nbinput.container div.input_area, .highlight {
background: var(--color-code-background)!important;
color: var(--color-content-foreground)!important;
}

div.nbinput.container div.input_area {
padding: .5rem!important;
/* border-radius: 0.5rem!important; */
box-shadow: 0 0 7px 2px rgba(0,0,0,.1);
}
Binary file removed docs/_static/favicon.ico
Binary file not shown.
Binary file added docs/_static/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/logo_light.jpg
Binary file not shown.
19 changes: 19 additions & 0 deletions docs/_static/logo_light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions docs/_static/logo_main.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 39 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
# -- Project information -----------------------------------------------------

project = "Piquasso"
copyright = "2021-2022, Budapest Quantum Computing Group"
copyright = "2021-2023, Budapest Quantum Computing Group"
author = "Budapest Quantum Computing Group"


Expand All @@ -36,7 +36,6 @@
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"nbsphinx",
"IPython.sphinxext.ipython_console_highlighting",
]


Expand Down Expand Up @@ -75,17 +74,52 @@
#
html_theme = "furo"

html_logo = "_static/logo_light.jpg"
html_favicon = "_static/favicon.ico"
html_static_path = ["_static"]
html_favicon = "_static/favicon.png"

pq_color = {
"pq-grey": "#656565",
"pq-smokey-white": "#f4f4f4",
"pq-blue-shade1": "#1e2844",
"pq-blue-shade2": "#273250",
"pq-blue-shade3": "#2f3b5a",
"pq-blue-shade4": "#364469",
"pq-font-color-shade1": "#ccd1da",
"pq-font-color-shade2": "#b2bac8",
"pq-font-color-shade3": "#8995a8",
"pq-font-color-shade4": "#717c8e",
"pq-color-red": "#e46363",
"pq-color-border": "#232d48",
"pq-color-border-dark": "#1a243e",
}

html_theme_options = {
"sidebar_hide_name": True,
"light_logo": "logo_light.svg",
"dark_logo": "logo_main.svg",
"dark_css_variables": {
"color-background-primary": pq_color["pq-blue-shade1"],
"color-background-secondary": pq_color["pq-blue-shade2"],
"color-code-background": pq_color["pq-blue-shade3"],

"color-foreground-primary": pq_color["pq-font-color-shade1"],
"color-foreground-secondary": pq_color["pq-font-color-shade2"],
"color-sidebar-link-text--top-level": pq_color["pq-font-color-shade1"],
"color-brand-primary": pq_color["pq-font-color-shade4"],

"color-brand-content": pq_color["pq-color-red"],
"color-admonition-title--note": pq_color["pq-color-red"],
"color-admonition-background": pq_color["pq-blue-shade3"],
"color-admonition-title-background--note": pq_color["pq-blue-shade2"],
"color-background-hover": pq_color["pq-blue-shade3"],
},
}

html_css_files = ['custom.css']

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]


# NBSPHINX
Expand Down

0 comments on commit f3959de

Please sign in to comment.