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

Enable optional links to *next* and *previous* items #101

Merged
merged 3 commits into from
May 14, 2018
Merged

Enable optional links to *next* and *previous* items #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5846975
Expand gitignore
MinchinWeb Apr 1, 2017
3e6bc4a
Remove blank lines from top of generated CSS
MinchinWeb Apr 1, 2017
ef6a82e
Enable option for `relbars`
MinchinWeb Apr 1, 2017
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
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
docs/_build
*.egg-info
*.py[cod]
45 changes: 44 additions & 1 deletion alabaster/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,30 @@
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
{% endblock %}

{# Disable base theme's top+bottom related navs; we have our own in sidebar #}
{# top+bottom related navs; we also have our own in sidebar #}
{%- macro rellink_markup() %}
<nav id="rellinks">
<ul>
{%- if prev %}
<li>
&larr;
<a href="{{ prev.link|e }}" title="Previous document">{{ prev.title }}</a>
</li>
{%- endif %}
{%- if next %}
<li>
<a href="{{ next.link|e }}" title="Next document">{{ next.title }}</a>
&rarr;
</li>
{%- endif %}
</ul>
</nav>
{%- endmacro %}

{%- set theme_show_relbar_top = theme_show_relbar_top or theme_show_relbars %}
{%- set theme_show_relbar_bottom = theme_show_relbar_bottom or theme_show_relbars %}

{# removed existing top+bottom related nav, and embed in main content #}
{%- block relbar1 %}{% endblock %}
{%- block relbar2 %}{% endblock %}

Expand All @@ -26,9 +49,29 @@
{%- if render_sidebar %}
<div class="bodywrapper">
{%- endif %}

{%- block relbar_top %}
{%- if theme_show_relbar_top|tobool %}
<div class="related top">
&nbsp;
{{- rellink_markup () }}
</div>
{%- endif %}
{% endblock %}

<div class="body" role="main">
{% block body %} {% endblock %}
</div>

{%- block relbar_bottom %}
{%- if theme_show_relbar_bottom|tobool %}
<div class="related bottom">
&nbsp;
{{- rellink_markup () }}
</div>
{%- endif %}
{% endblock %}

{%- if render_sidebar %}
</div>
{%- endif %}
Expand Down
121 changes: 85 additions & 36 deletions alabaster/static/alabaster.css_t
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
{% set theme_body_bg = theme_body_bg or theme_base_bg %}
{% set theme_code_highlight_bg = theme_code_highlight_bg or theme_body_bg %}
{% set theme_sidebar_header = theme_sidebar_header or theme_gray_1 %}
{% set theme_sidebar_link = theme_sidebar_link or theme_gray_1 %}
{% set theme_anchor_hover_fg = theme_anchor_hover_fg or theme_gray_1 %}
{%- set theme_body_bg = theme_body_bg or theme_base_bg %}
{%- set theme_code_highlight_bg = theme_code_highlight_bg or theme_body_bg %}
{%- set theme_sidebar_header = theme_sidebar_header or theme_gray_1 %}
{%- set theme_sidebar_link = theme_sidebar_link or theme_gray_1 %}
{%- set theme_anchor_hover_fg = theme_anchor_hover_fg or theme_gray_1 %}

{% set theme_footnote_border = theme_footnote_border or theme_gray_2 %}
{% set theme_pre_bg = theme_pre_bg or theme_gray_2 %}
{%- set theme_footnote_border = theme_footnote_border or theme_gray_2 %}
{%- set theme_pre_bg = theme_pre_bg or theme_gray_2 %}


{# set up admonition styling #}
{# - basic level #}
{% set theme_admonition_xref_bg = theme_admonition_xref_bg or theme_xref_bg %}
{% set theme_admonition_bg = theme_admonition_bg or theme_gray_2 %}
{% set theme_note_bg = theme_note_bg or theme_gray_2 %}
{% set theme_seealso_bg = theme_seealso_bg or theme_gray_2 %}
{#- set up admonition styling #}
{#- - basic level #}
{%- set theme_admonition_xref_bg = theme_admonition_xref_bg or theme_xref_bg %}
{%- set theme_admonition_bg = theme_admonition_bg or theme_gray_2 %}
{%- set theme_note_bg = theme_note_bg or theme_gray_2 %}
{%- set theme_seealso_bg = theme_seealso_bg or theme_gray_2 %}

{# - critical level #}
{% set theme_danger_bg = theme_danger_bg or theme_pink_1 %}
{% set theme_danger_border = theme_danger_border or theme_pink_2 %}
{% set theme_danger_shadow = theme_danger_shadow or theme_pink_3 %}
{#- - critical level #}
{%- set theme_danger_bg = theme_danger_bg or theme_pink_1 %}
{%- set theme_danger_border = theme_danger_border or theme_pink_2 %}
{%- set theme_danger_shadow = theme_danger_shadow or theme_pink_3 %}

{% set theme_error_bg = theme_error_bg or theme_pink_1 %}
{% set theme_error_border = theme_error_border or theme_pink_2 %}
{% set theme_error_shadow = theme_error_shadow or theme_pink_3 %}
{%- set theme_error_bg = theme_error_bg or theme_pink_1 %}
{%- set theme_error_border = theme_error_border or theme_pink_2 %}
{%- set theme_error_shadow = theme_error_shadow or theme_pink_3 %}

{# - warning level #}
{% set theme_caution_bg = theme_caution_bg or theme_pink_1 %}
{% set theme_caution_border = theme_caution_border or theme_pink_2 %}
{#- - warning level #}
{%- set theme_caution_bg = theme_caution_bg or theme_pink_1 %}
{%- set theme_caution_border = theme_caution_border or theme_pink_2 %}

{% set theme_attention_bg = theme_attention_bg or theme_pink_1 %}
{% set theme_attention_border = theme_attention_border or theme_pink_2 %}
{%- set theme_attention_bg = theme_attention_bg or theme_pink_1 %}
{%- set theme_attention_border = theme_attention_border or theme_pink_2 %}

{% set theme_warn_bg = theme_warn_bg or theme_pink_1 %}
{% set theme_warn_border = theme_warn_border or theme_pink_2 %}
{%- set theme_warn_bg = theme_warn_bg or theme_pink_1 %}
{%- set theme_warn_border = theme_warn_border or theme_pink_2 %}

{# - normal level #}
{% set theme_important_bg = theme_important_bg or theme_gray_2 %}
{% set theme_tip_bg = theme_tip_bg or theme_gray_2 %}
{% set theme_hint_bg = theme_hint_bg or theme_gray_2 %}
{#- - normal level #}
{%- set theme_important_bg = theme_important_bg or theme_gray_2 %}
{%- set theme_tip_bg = theme_tip_bg or theme_gray_2 %}
{%- set theme_hint_bg = theme_hint_bg or theme_gray_2 %}

{# /set up admonition styling #}
{#- /set up admonition styling #}

{% set theme_shadow = theme_shadow or theme_gray_2 %}
{%- set theme_shadow = theme_shadow or theme_gray_2 %}


{% set theme_topic_bg = theme_topic_bg or theme_gray_2 %}
{%- set theme_topic_bg = theme_topic_bg or theme_gray_2 %}

{% set theme_narrow_sidebar_link = theme_narrow_sidebar_link or theme_gray_3 %}
{% set theme_sidebar_hr = theme_sidebar_hr or theme_gray_3 %}
{%- set theme_narrow_sidebar_link = theme_narrow_sidebar_link or theme_gray_3 %}
{%- set theme_sidebar_hr = theme_sidebar_hr or theme_gray_3 %}

{%- set theme_relbar_border = theme_relbar_border or theme_gray_2 -%}


@import url("basic.css");
Expand Down Expand Up @@ -704,3 +706,50 @@ table.docutils.citation, table.docutils.citation td, table.docutils.citation th
-webkit-box-shadow: none;
box-shadow: none;
}


/* relbar */

.related {
line-height: 30px;
width: 100%;
font-size: 0.9rem;
}

.related.top {
border-bottom: 1px solid {{ theme_relbar_border }};
margin-bottom: 20px;
}

.related.bottom {
border-top: 1px solid {{ theme_relbar_border }};
}

.related ul {
padding: 0;
margin: 0;
list-style: none;
}

.related li {
display: inline;
}

nav#rellinks {
float: right;
}

nav#rellinks li+li:before {
content: "|";
}

nav#breadcrumbs li+li:before {
content: "\00BB";
}

/* Hide certain items when printing */
@media print {
div.related {
display: none;
}
}
4 changes: 4 additions & 0 deletions alabaster/theme.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ sidebar_includehidden = true
sidebar_collapse = true
show_powered_by = true
show_related = false
show_relbars = false
show_relbar_top =
show_relbar_bottom =

gray_1 = #444
gray_2 = #EEE
Expand Down Expand Up @@ -119,3 +122,4 @@ code_highlight = #FFC
page_width = 940px
sidebar_width = 220px
fixed_sidebar = false
relbar_border =
3 changes: 3 additions & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
Changelog
=========

* :feature:`18` add optional *next* and *previous* links at the top and bottom
of page content. Use theme option ``show_relbars`` to enable these. Credit:
William Minchin.
* :release:`0.7.10 <2017-02-28>`
* :bug:`32` Update styling of various block-level elements such as admonitions
(``.. note::``, ``.. warning::``, etc) and code blocks (``.. code::``) so
Expand Down
6 changes: 6 additions & 0 deletions docs/customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,10 @@ Variables and feature toggles
main body of the page scrolls but the sidebar remains visible. (Applies only
to desktop window sizes; the mobile view is unaffected.) Defaults to
``false``.
* ``show_relbars``: ``true`` or ``false`, defaults to ``false`` - used to
display *next* and *previous* links above and below the main page content. If
you only want to display one, this setting can be further overriden through
the ``show_relbar_top`` and ``show_relbar_bottom`` settings.

Style colors
------------
Expand Down Expand Up @@ -208,6 +212,8 @@ colorscheme. The more granular settings can be used to override as needed.
* ``narrow_sidebar_fg``: Text color of same.
* ``narrow_sidebar_link``: Link color of same. Defaults to ``gray_3``.
* ``code_highlight``: Color of highlight when using ``:emphasize-lines:`` in a code block.
* ``relbar_border``: Color of border between bar holding *next* and *previous*
links, the rest of the page content. Defulats to ``gray_2``.

Fonts
-----
Expand Down