Skip to content

Commit

Permalink
Improve RTD theming (#1180)
Browse files Browse the repository at this point in the history
- use JuPedSim blue for heading
- remove theme switcher
- add PyPI badge
- add Zenodo badge
  • Loading branch information
schroedtert authored Sep 22, 2023
1 parent 0312290 commit e85be86
Show file tree
Hide file tree
Showing 3 changed files with 238 additions and 3 deletions.
200 changes: 200 additions & 0 deletions docs/source/_static/jupedsim.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion readthedocs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,15 @@
/* Provided by Sphinx's 'basic' theme, and included in the final set of assets */
@import "../basic.css";

html[data-theme="light"] {
/*Set main color to match color of main logo color */
--pst-color-primary: rgb(0 86 118);
}
}

h1, h2 {
color: #005676 !important;
font-weight: bolder;
}
h3, h4, h5, h6 {
color: #005676 !important;
}
28 changes: 26 additions & 2 deletions readthedocs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,35 @@
html_context = {"default_mode": "light"}

html_theme_options = {
"github_url": "https://github.com/PedestrianDynamics/jupedsim",
"home_page_in_toc": True,
"home_page_in_toc": False,
"use_fullscreen_button": False,
"use_issues_button": False,
"use_download_button": False,
"article_header_end": ["search-button", "toggle-secondary-sidebar"],
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/PedestrianDynamics/jupedsim",
"icon": "fa-brands fa-github",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/jupedsim/",
"icon": "https://img.shields.io/pypi/v/jupedsim",
"type": "url",
},
{
"name": "DOI",
"url": "https://doi.org/10.5281/zenodo.6470814",
"icon": "https://zenodo.org/badge/DOI/10.5281/zenodo.6470814.svg",
"type": "url",
},
],
"show_toc_level": 3,
}

html_sidebars = {
"**": ["navbar-logo", "icon-links", "search-field", "sbt-sidebar-nav.html"]
}

# -- Options for EPUB output
Expand Down

0 comments on commit e85be86

Please sign in to comment.