Skip to content

New Feature: Add notoc theme option #125

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

Open
jdillard wants to merge 1 commit into
base: main
Choose a base branch
from
Open

New Feature: Add notoc theme option #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ Additional options for the theme. The default theme ``simplepdf_theme`` inherits
``simplepdf_theme`` options:

:nocover: Do not display cover pages (front and back cover)
:notoc: Do not display the Table of Contents page


simplepdf_weasyprint_filter
Expand Down
3 changes: 2 additions & 1 deletion sphinx_simplepdf/themes/simplepdf_theme/page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{%- extends "layout.html" %}
{%- set render_cover = (not theme_nocover|tobool) %}
{%- set render_toc = (not theme_notoc|tobool) %}

{%- block extrahead %}

Expand All @@ -8,7 +9,7 @@
{%- if render_cover %}
{%- include "cover.html" -%}
{%- endif %}
{{ sidebar() }}
{%- if render_toc %}{{ sidebar() }}{%- endif %}
{% endblock %}
{% block body %}
{{ body }}
Expand Down
2 changes: 2 additions & 0 deletions sphinx_simplepdf/themes/simplepdf_theme/static/styles/sources/_toc.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
}

// .. toctree:: config
@if not $notoc {
.sphinxsidebarwrapper {

page-break-before: always;
Expand Down Expand Up @@ -159,3 +160,4 @@
}
}
}
} // @if not $notoc
1 change: 1 addition & 0 deletions sphinx_simplepdf/themes/simplepdf_theme/static/styles/sources/_variables.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ $bottom-center-content: config('bottom-center-content', '') !default;
$bottom-right-content: config('bottom-right-content', '') !default;

$nocover: theme_option('nocover', false) !default;
$notoc: theme_option('notoc', false) !default;
1 change: 1 addition & 0 deletions sphinx_simplepdf/themes/simplepdf_theme/theme.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ globaltoc_collapse = false
globaltoc_includehidden = false
globaltoc_maxdepth = 1
nocover = false
notoc = false