diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 0000000..0d56fc1 --- /dev/null +++ b/docs/_templates/layout.html @@ -0,0 +1,31 @@ +{% extends "pydata_sphinx_theme/layout.html" %} +{# ref: https://github.com/pydata/pydata-sphinx-theme/blob/master/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html #} + +{% block docs_main %} +{# A tiny helper pixel to detect if we've scrolled #} +
+{{ super() }} +{% endblock %} + + +{% block docs_body %} +{# Table of contents that is only displayed when printing the page #} +
+

{{ pagetitle }}

+ +
+
+ {% set page_toc = generate_toc_html() %} + {%- if page_toc | length >= 1 %} +
+

{{ translate(theme_toc_title) }}

+
+ + {%- endif %} +
+
+
+{{ super() }} +{% endblock %} diff --git a/docs/_templates/theme.conf b/docs/_templates/theme.conf new file mode 100644 index 0000000..2724064 --- /dev/null +++ b/docs/_templates/theme.conf @@ -0,0 +1,55 @@ +[theme] +inherit = pydata_sphinx_theme +pygments_style = tango +sidebars = navbar-logo.html, icon-links.html, sbt-sidebar-nav.html +stylesheet = styles/sphinx-book-theme.css + +[options] +# Announcement bar (empty by default) +announcement = + +# Secondary sidebar: Removes the extra page-specific links from sidebar +secondary_sidebar_items = page-toc.html +toc_title = Contents + +# Article header: The top bar that is displayed on most pages +article_header_start = toggle-primary-sidebar.html +article_header_end = article-header-buttons.html +use_download_button = True +use_fullscreen_button = True +use_issues_button = False +use_source_button = False +use_repository_button = False +# Note: We also inherit use_edit_page_button from the PyData theme + +# Configuration for GitHub / GitLab repo buttons +path_to_docs = +repository_url = +repository_branch = +repository_provider = +launch_buttons = {} + +# Header / navbar. +# Over-ride the PST navbar components (users could provide their own if they wish) +navbar_start = +navbar_center = +navbar_end = +navbar_persistent = + +# Primary sidebar behavior +home_page_in_toc = False +show_navbar_depth = 1 + +# Footer at the bottom of the content +extra_footer = +footer_content_items = author.html, copyright.html, last-updated.html, extra-footer.html + +# Footer at the bottom of the site (PST over-ride) +footer_start = +footer_end = + +# Content and directive flags +use_sidenotes = False + +# DEPRECATE after a few release cycles +expand_toc_sections = []