Skip to content

Commit

Permalink
Start restructuring and restyling the docs.
Browse files Browse the repository at this point in the history
Tweaked icon, switch to furo, custom colors
  • Loading branch information
ceriottm committed Nov 2, 2024
1 parent 84740a5 commit 01c52b1
Show file tree
Hide file tree
Showing 6 changed files with 609 additions and 84 deletions.
Binary file modified app/chemiscope-icon.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 modified docs/_static/chemiscope-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
659 changes: 591 additions & 68 deletions docs/_static/chemiscope-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions docs/_static/css/chemiscope.css
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ pre {
.admonition.note a:hover {
color: #18bc9c;
}

.sidebar-logo {
display: block;
margin: 0 auto;
max-width: 100%;
clip-path: inset(9px 9px 25px 9px);
transform: scale(1.3);
}
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
sphinx>=4
sphinx-bootstrap-theme
sphinx_rtd_theme # sphinx theme
sphinx-argparse-cli
sphinx-gallery
furo

# required to be able to import chemiscope in the doc
numpy
Expand Down
23 changes: 8 additions & 15 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
import os

import sphinx_bootstrap_theme

import chemiscope
from chemiscope.sphinx import ChemiscopeScraper

Expand Down Expand Up @@ -57,25 +55,20 @@

# -- Options for HTML output -------------------------------------------------

html_theme = "bootstrap"
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme = "furo"

html_theme_options = {
"navbar_links": [
("Documentation", "index.html", True),
],
"navbar_pagenav": False,
"bootswatch_theme": "flatly",
"source_link_position": None,
"light_css_variables": {
"color-background-secondary": "#cbd9f0",
},
"dark_css_variables": {
"color-background-secondary": "#303d4f",
},
}

html_sidebars = {"**": ["sidebar-toc.html", "searchbox.html"]}

# 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 = [os.path.join("..", "_static")]
html_favicon = "../_static/chemiscope-icon.png"
html_logo = "../_static/chemiscope-icon.svg"

templates_path = [os.path.join("..", "_templates")]

Expand Down

0 comments on commit 01c52b1

Please sign in to comment.