Add beeware.org header to Furo Sphinx theme. #3538
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| <!doctype html> | ||
| <html class="no-js"{% if language is not none %} lang="{{ language }}"{% endif %} data-content_root="{{ content_root }}"> | ||
| <head> | ||
| {%- block site_meta -%} | ||
| <meta charset="utf-8"/> | ||
| <meta name="viewport" content="width=device-width,initial-scale=1"/> | ||
| <meta name="color-scheme" content="light dark"> | ||
|
|
||
| {%- if metatags %}{{ metatags }}{% endif -%} | ||
|
|
||
| {%- block linktags %} | ||
| {%- if hasdoc('about') -%} | ||
| <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" /> | ||
| {%- endif -%} | ||
| {%- if hasdoc('genindex') -%} | ||
| <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" /> | ||
| {%- endif -%} | ||
| {%- if hasdoc('search') -%} | ||
| <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" /> | ||
| {%- endif -%} | ||
| {%- if hasdoc('copyright') -%} | ||
| <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" /> | ||
| {%- endif -%} | ||
| {%- if next -%} | ||
| <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" /> | ||
| {%- endif -%} | ||
| {%- if prev -%} | ||
| <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" /> | ||
| {%- endif -%} | ||
| {#- rel="canonical" (set by html_baseurl) -#} | ||
| {%- if pageurl %} | ||
| <link rel="canonical" href="{{ pageurl|e }}" /> | ||
| {%- endif %} | ||
| {%- endblock linktags %} | ||
|
|
||
| {# Favicon #} | ||
| {%- if favicon_url -%} | ||
| <link rel="shortcut icon" href="{{ favicon_url }}"/> | ||
| {%- endif -%} | ||
|
|
||
| <!-- Generated with Sphinx {{ sphinx_version }} and Furo {{ furo_version }} --> | ||
|
|
||
| {%- endblock site_meta -%} | ||
|
|
||
| {#- Site title -#} | ||
| {%- block htmltitle -%} | ||
| {% if not docstitle %} | ||
| <title>{{ title|striptags|e }}</title> | ||
| {% elif pagename == master_doc %} | ||
| <title>{{ docstitle|striptags|e }}</title> | ||
| {% else %} | ||
| <title>{{ title|striptags|e }} - {{ docstitle|striptags|e }}</title> | ||
| {% endif %} | ||
| {%- endblock -%} | ||
|
|
||
| {%- block styles -%} | ||
|
|
||
|
|
||
| {# Custom stylesheets #} | ||
| {%- block regular_styles -%} | ||
| {%- for css in css_files -%} | ||
| {% if css|attr("filename") -%} | ||
| {{ css_tag(css) }} | ||
| {%- else -%} | ||
| <link rel="stylesheet" href="{{ pathto(css, 1)|e }}" type="text/css" /> | ||
| {%- endif %} | ||
| {% endfor -%} | ||
| {%- endblock regular_styles -%} | ||
|
|
||
| {#- Theme-related stylesheets -#} | ||
| {%- block theme_styles %} | ||
| {% include "partials/_head_css_variables.html" with context %} | ||
| {%- endblock -%} | ||
| <!-- Bootstrap CSS --> | ||
| <link rel="stylesheet" type="text/css" href="https://beeware.org/static/bootstrap/css/bootstrap.min.css"> | ||
| <link rel="stylesheet" type="text/css" href="https://beeware.org/static/bootstrap/css/bootstrap-grid.min.css"> | ||
| <!-- BeeWare Font --> | ||
| <link rel="stylesheet" type="text/css" href="//fonts.googleapis.com/css?family=Cutive"> | ||
| {%- block extra_styles %} | ||
| {%- endblock -%} | ||
|
|
||
| <!-- Font Awesome --> | ||
| <script src="https://kit.fontawesome.com/078c86a30a.js" crossorigin="anonymous"></script> | ||
|
There was a problem hiding this comment. Mental note that I may need to modify my font-awesome domain permission here. |
||
| {%- endblock styles -%} | ||
|
|
||
| {#- Custom front matter #} | ||
| {%- block extrahead -%}{%- endblock -%} | ||
| </head> | ||
| <body> | ||
| {% block body %} | ||
| <script> | ||
| document.body.dataset.theme = localStorage.getItem("theme") || "auto"; | ||
| </script> | ||
| {% include "header.html" %} | ||
| {% endblock %} | ||
|
|
||
| {%- block scripts -%} | ||
|
|
||
| {# Custom JS #} | ||
| {%- block regular_scripts -%} | ||
| <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script> | ||
| <script src="https://beeware.org/static/bootstrap/js/bootstrap.min.js"></script> | ||
|
There was a problem hiding this comment. From the look of the javascript console when running locally,=, there's another JS file needed here (popper.js) |
||
| {% for path in script_files -%} | ||
| {{ js_tag(path) }} | ||
| {% endfor -%} | ||
| {%- endblock regular_scripts -%} | ||
|
|
||
| {# Theme-related JavaScript code #} | ||
| {%- block theme_scripts -%} | ||
| {%- endblock -%} | ||
|
|
||
| {%- endblock scripts -%} | ||
| </body> | ||
| </html> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> | ||
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsDefault" aria-controls="navbarsDefault" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <span class="navbar-toggler-icon"></span> | ||
| </button> | ||
| <div class="nav-top"> | ||
| <div class="navbar-brand-block"> | ||
| <a class="navbar-brand" href="https://beeware.org"><img class="mx-2" src="/_static/images/brutus-32.png">BeeWare</a> | ||
|
There was a problem hiding this comment. This isn't rendering on the RTD preview... I suspect because the root URL for RTD won't have this. Don't know if there's a better fix for this, and maybe we just have to live with it. There was a problem hiding this comment. The other problem with troubleshooting this is that it renders in testing. So I would have to start making changes, pushing them, and seeing whether RtD shapes up. I'm ok with doing this, but not unless you confirm you want me to. Please let me know your thoughts. There was a problem hiding this comment. I'm OK with this being a "known issue" with testing. We already have analogous issues with font-awesome icons; as long as we know the limitation exists, we can work around it. I was more hoping there might be a "{{ root_url }}" template piece that could be used - but if there isn't, that's fine. There was a problem hiding this comment. I didn't know this was a thing. It renders locally with the latest addition. We'll see if it works with RtD. There was a problem hiding this comment. Oh - I have no idea if There was a problem hiding this comment. Oh fair enough. I'll dig a bit further... There was a problem hiding this comment. So RtD evidently automatically supplies a |
||
| </div> | ||
| </div> | ||
| <div class="collapse navbar-collapse" id="navbarsDefault"> | ||
| <ul class="navbar-nav mr-auto"> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/about">About</a> | ||
|
There was a problem hiding this comment. Observation - these render on beeware.org as "unselected" unless it's the current page. I'm pretty sure we can just render |
||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/project">Projects</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/community">Community</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/contributing">Contributing</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/news">News</a> | ||
| </li> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="https://beeware.org/membership">Donate</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </nav> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| {#- | ||
|
|
||
| Hi there! | ||
|
|
||
| You might be interested in https://pradyunsg.me/furo/customisation/sidebar/ | ||
|
|
||
| Although if you're reading this, chances are that you're either familiar | ||
| enough with Sphinx that you know what you're doing, or landed here from that | ||
| documentation page. | ||
|
|
||
| Hope your day's going well. :) | ||
|
There was a problem hiding this comment. 🤣 Is this your doing, or Pradyuns? There was a problem hiding this comment. Entirely Pradyun's. It exists in all the files that you can customise through the Furo config, as an attempt to avoid you unnecessarily doing what we're doing. It is necessary for us, so here we are. Probably not worth removing, as any future diff would include it and show up as a change to be updated. That said, I can obviously remove it if you prefer. There was a problem hiding this comment. Oh no - keep it in. If someone is elbow deep in this file, they deserve a little pick me up :-) |
||
|
|
||
| -#} | ||
| <a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}"> | ||
| {% block brand_content %} | ||
| {%- if logo_url %} | ||
| <div class="sidebar-logo-container"> | ||
| <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/> | ||
| </div> | ||
| {%- endif %} | ||
| {%- if theme_light_logo and theme_dark_logo %} | ||
| <div class="sidebar-logo-container"> | ||
| <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/> | ||
| <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/> | ||
| </div> | ||
| {%- endif %} | ||
| {% if not theme_sidebar_hide_name %} | ||
| <span class="sidebar-brand-text">{{ docstitle if docstitle else project }}</span> | ||
| {%- endif %} | ||
| {% endblock brand_content %} | ||
| </a> | ||
| <div class="github-links"> | ||
| <div class="github-link"> | ||
| <a href="https://github.com/beeware/toga">Source Code</a> | ||
| </div> | ||
| <div class="github-link"> | ||
| <a href="https://github.com/beeware/toga/issues">Issues</a> | ||
| </div> | ||
| </div> | ||
Uh oh!
There was an error while loading. Please reload this page.