Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update html Layout fixes issues and improves html5 usage #1122

Open
wants to merge 23 commits into
base: master
Choose a base branch
from
Open

Update html Layout fixes issues and improves html5 usage #1122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
2cc0970
Cleanup: Sass formatting
Blendify Apr 8, 2021
dcf2aea
Revert Extra Tabbing
Blendify Apr 8, 2021
276825d
Add back missing line
Blendify Apr 8, 2021
e5bbc13
Add whitespace back
Blendify Apr 8, 2021
3652d3d
Fix whitespace 2
Blendify Apr 8, 2021
1b8cc7d
Merge branch 'master' into Blendify/format
Blendify Apr 9, 2021
e463341
Update html Layout fixes issues and improves html5 usage
Blendify Apr 9, 2021
7b43f00
Merge branch 'master' into Blendify/update-layout
Blendify Apr 9, 2021
aaf7533
Fix printing
Blendify Apr 9, 2021
5fdcbb0
Merge branch 'Blendify/update-layout' of github.com:readthedocs/sphin…
Blendify Apr 9, 2021
492c87a
FIx background color
Blendify Apr 9, 2021
e818458
Fix versions flyout on rtd
Blendify Apr 9, 2021
da832e3
Fix mobile overflow
Blendify Apr 9, 2021
0c298c3
Build assets
Blendify Apr 9, 2021
7d9df00
Fix Content width on shift
Blendify Apr 9, 2021
96bd2ed
Cleanup: Whitespace
Blendify Apr 9, 2021
8b35617
Don't print header
Blendify Apr 10, 2021
fcd6201
Fix sidebar on landscape phones
Blendify Apr 10, 2021
83cc596
Compile CSS
Blendify Apr 10, 2021
98ac0df
Hide breadcrumbs aside sooner
Blendify Apr 10, 2021
22619e7
Adjust padding only when less than 800px
Blendify Apr 10, 2021
65b653d
Build css
Blendify Apr 10, 2021
db5b304
Merge branch 'master' into Blendify/update-layout
Blendify Apr 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/_templates/layout.html → docs/_templates/versions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{%- extends "!layout.html" %}
{%- extends "!versions.html" %}

{#-

Expand All @@ -8,7 +8,7 @@

#}

{%- block footer %}
{%- block rstversions %}
{%- if not READTHEDOCS %}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
Expand Down Expand Up @@ -51,5 +51,7 @@
</dl>
</div>
</div>
{%- else %}
{{ super() }}
{%- endif %}
{%- endblock %}
4 changes: 2 additions & 2 deletions sphinx_rtd_theme/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

{%- set display_vcs_links = display_vcs_links if display_vcs_links is defined else True %}

<div role="navigation" aria-label="{{ _('Breadcrumbs') }}">
<nav aria-label="{{ _('Breadcrumbs') }}">
<ul class="wy-breadcrumbs">
{%- block breadcrumbs %}
<li><a href="{{ pathto(master_doc) }}" class="icon icon-home"></a> &raquo;</li>
Expand Down Expand Up @@ -72,4 +72,4 @@
</div>
{%- endif %}
<hr/>
</div>
</nav>
164 changes: 78 additions & 86 deletions sphinx_rtd_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,103 +111,95 @@
{%- block extrahead %} {% endblock %}
</head>

<body class="wy-body-for-nav">

<body>
{%- block extrabody %} {% endblock %}
<div class="wy-grid-for-nav">
{#- SIDE NAV, TOGGLES ON MOBILE #}
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block sidebartitle %}

{%- if logo and theme_logo_only %}
<a href="{{ pathto(master_doc) }}">
{%- else %}
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
{%- endif %}
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
<header>
<nav data-toggle="wy-nav-shift" class="wy-nav-top" aria-label="{{ _('Top') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block mobile_nav %}
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
{%- endblock %}
</nav>
</header>

{#- SIDE NAV, TOGGLES ON MOBILE #}
<aside data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block sidebartitle %}

{%- if logo and theme_logo_only %}
<a href="{{ pathto(master_doc) }}">
{%- else %}
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
{%- endif %}

{%- if logo %}
{#- Not strictly valid HTML, but it's the only way to display/scale
it properly, without weird scripting or heaps of work
#}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
{%- endif %}
</a>

{%- if logo %}
{#- Not strictly valid HTML, but it's the only way to display/scale
it properly, without weird scripting or heaps of work
#}
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="{{ _('Logo') }}"/>
{%- if theme_display_version %}
{%- set nav_version = version %}
{%- if READTHEDOCS and current_version %}
{%- set nav_version = current_version %}
{%- endif %}
</a>

{%- if theme_display_version %}
{%- set nav_version = version %}
{%- if READTHEDOCS and current_version %}
{%- set nav_version = current_version %}
{%- endif %}
{%- if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{%- endif %}
{%- if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{%- endif %}
{%- endif %}

{%- include "searchbox.html" %}

{%- include "searchbox.html" %}

{%- endblock %}
</div>

{%- block navigation %}
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Main') }}">
{%- block menu %}
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
collapse=theme_collapse_navigation|tobool,
includehidden=theme_includehidden|tobool,
titles_only=theme_titles_only|tobool) %}
{%- if toctree %}
{{ toctree }}
{%- else %}
<!-- Local TOC -->
<div class="local-toc">{{ toc }}</div>
{%- endif %}
{%- endblock %}
</div>
{%- endblock %}
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
<nav class="wy-nav-top" aria-label="{{ _('Top') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}>
{%- block mobile_nav %}
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
{%- block navigation %}
<nav class="wy-menu wy-menu-vertical" data-spy="affix" aria-label="{{ _('Main') }}">
{%- block menu %}
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int,
collapse=theme_collapse_navigation|tobool,
includehidden=theme_includehidden|tobool,
titles_only=theme_titles_only|tobool) %}
{%- if toctree %}
{{ toctree }}
{%- else %}
<!-- Local TOC -->
<div class="local-toc">{{ toc }}</div>
{%- endif %}
{%- endblock %}
</nav>

<div class="wy-nav-content">
{%- block content %}
{%- if theme_style_external_links|tobool %}
<div class="rst-content style-external-links">
{%- else %}
<div class="rst-content">
{%- endif %}
{% include "breadcrumbs.html" %}
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
{%- block document %}
<div itemprop="articleBody">
{% block body %}{% endblock %}
</div>
{%- if self.comments()|trim %}
<div class="articleComments">
{%- block comments %}{% endblock %}
</div>
{%- endif%}
</div>
{%- endblock %}
{% include "footer.html" %}
</div>
{%- endblock %}
</div>
</section>
</div>
{% include "versions.html" -%}
</div>
{% include "versions.html" %}
</aside>

<section data-toggle="wy-nav-shift" class="wy-nav-content">
{%- block content %}
{% include "breadcrumbs.html" %}
{%- if theme_style_external_links|tobool %}
<main class="rst-content style-external-links">
{%- else %}
<main class="rst-content">
{%- endif %}
{%- block document %}
{% block body %}{% endblock %}
{%- if self.comments()|trim %}
<section class="articleComments">
{%- block comments %}{% endblock %}
</section>
{%- endif%}
</main>
{%- endblock %}
{% include "footer.html" %}
{%- endblock %}
</section>

<script type="text/javascript">
jQuery(function () {
Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/static/css/badge_only.css
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sphinx_rtd_theme/static/css/theme.css
View file
Open in desktop

Large diffs are not rendered by default.

Loading