Skip to content

Commit

Permalink
Fix docs to work with Sphinx Theme 1.11 (#867)
Browse files Browse the repository at this point in the history 
* Fix docs to work with Sphinx Theme 1.11

* Update docs/source/_templates/sidebar.html

Co-authored-by: Matthew Treinish <[email protected]>
  • Loading branch information
@Eric-Arellano @mtreinish
Eric-Arellano and mtreinish authored May 8, 2023
1 parent 7ed0f1f commit 1bd168a
Show file tree
Hide file tree
Showing 6 changed files with 205 additions and 248 deletions.
300 changes: 101 additions & 199 deletions docs/source/_templates/layout.html
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,25 @@
{# TEMPLATE VAR SETTINGS #}
{%- set url_root = pathto('', 1) %}
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
{# Sphinx template variable setup #}
{%- if not embedded and docstitle %}
{%- set titlesuffix = " &mdash; "|safe + docstitle|e %}
{%- else %}
{%- set titlesuffix = "" %}
{%- endif %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
{% import 'theme_variables.jinja' as theme_variables %}
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) -%}

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
<html class="no-js" lang="{{ lang_attr }}" >
<head>
<meta charset="utf-8">
{{ metatags }}
<meta charset="{{ encoding }}">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
{% block htmltitle %}
{{ metatags }}
{%- block htmltitle %}
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
{% endblock %}

{# FAVICON #}
{% if favicon %}
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
{% endif %}
{# CANONICAL URL #}
{% if theme_canonical_url %}
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
{% endif %}

{# CSS #}

{# OPENSEARCH #}
{% if not embedded %}
{% if use_opensearch %}
<link rel="search" type="application/opensearchdescription+xml"
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
href="{{ pathto('_static/opensearch.xml', 1) }}"/>
{% endif %}

{% endif %}
{%- endblock %}
{%- if favicon_url %}
<link rel="shortcut icon" href="{{ favicon_url }}" />
{%- endif %}

<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
<!-- <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" /> -->
{#- CSS #}
{%- for css in css_files %}
{%- if css|attr("rel") %}
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} />
Expand All @@ -51,131 +28,116 @@
{%- endif %}
{%- endfor %}
{%- for cssfile in extra_css_files %}
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor %}

{%- 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 %}
{%- endblock %}
{%- block extrahead %} {% endblock %}

{# Keep modernizr in head - http://modernizr.com/docs/#installing #}
<script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
{%- endfor -%}

<!-- SEGMENT ANALYTICS -->
{%- if analytics_enabled %}
<script>
(function () {
window._analytics = {
segment_key: 'ffdYLviQze3kzomaINXNk6NwpY9LlXcw',
coremetrics: false,
optimizely: false,
googleAddServices: false,
fullStory: false,
autoPageEventSpa: false,
autoFormEvents: false,
autoPageView: false
}

window.digitalData = {
page: {
pageInfo: {
productTitle: 'IBM Q Experience',
analytics: {
category: 'Qiskit.org'
}
}
}
}
}());
</script>
<script src="https://cloud.ibm.com/analytics/build/bluemix-analytics.min.js"></script>
<script>
(function () {
'use strict'

if (!window.bluemixAnalytics || !window.digitalData) { return }

const category = window.digitalData.page.pageInfo.analytics.category
const productTitle = window.digitalData.page.pageInfo.productTitle
const routeName = 'documentation'

window.bluemixAnalytics.pageEvent(category, routeName, {
navigationType: 'pushState',
productTitle: productTitle,
title: document.title
})

window.trackCta = (action) => {
if (!window.bluemixAnalytics || !window.digitalData) { return }

const category = window.digitalData.page.pageInfo.analytics.category
const productTitle = window.digitalData.page.pageInfo.productTitle

window.bluemixAnalytics.trackEvent('CTA Clicked', {
productTitle,
category,
CTA: action
})
}

}());
</script>
{%- endif -%}

</head>

<body class="pytorch-body">

{% block extrabody %} {% endblock %}

{# SIDE NAV, TOGGLES ON MOBILE #}
<!-- LEFT SIDE BAR -->

{% include "versions.html" %}
<!-- if translations available, display language dropdown menu -->
{% include "languages.html" %}

<!-- Menu becomes dropdown in mobile view -->
<div class="table-of-contents-link-wrapper">
<span>Table of Contents</span>
<a href="#" class="toggle-table-of-contents" data-behavior="toggle-table-of-contents"></a>
</div>

<nav data-toggle="wy-nav-shift" class="pytorch-left-menu" id="pytorch-left-menu">
<div class="pytorch-side-scroll">
<div class="pytorch-menu pytorch-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<div class="pytorch-left-menu-search">
{% block sidebartitle %}

{% 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 %}
{% endif %}

{% include "searchbox.html" %}

{% endblock %}
</div>

{% block menu %}
{#
The singlehtml builder doesn't handle this toctree call when the
toctree is empty. Skip building this for now.
#}
{% if 'singlehtml' not in builder %}
{% set global_toc = toctree(maxdepth=1,
collapse=theme_collapse_navigation|tobool,
includehidden=theme_includehidden|tobool,
titles_only=theme_titles_only|tobool) %}
{% endif %}
{% if global_toc %}
{{ global_toc }}
{% else %}
<!-- Local TOC -->
<div class="local-toc">{{ toc }}</div>
{% endif %}
{% endblock %}
</div>
</div>
</nav>
<!-- left side bar main content -->
{% include "sidebar.html" %}

<div class="pytorch-container">

<!-- BREADCRUMB MINI MENU BELOW TOP NAV BAR -->
<div class="pytorch-page-level-bar" id="pytorch-page-level-bar">
<div class="pytorch-breadcrumbs-wrapper">
{% include "breadcrumbs.html" %}
</div>

<div class="pytorch-shortcuts-wrapper" id="pytorch-shortcuts-wrapper">
Shortcuts
</div>
</div>

<!-- MAIN CENTRE CONTENT -->
<section data-toggle="wy-nav-shift" id="pytorch-content-wrap" class="pytorch-content-wrap">
<div class="pytorch-content-left">

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

<!-- RIGHT SIDE AUTOSUMMARY MENU -->
<div class="pytorch-content-right" id="pytorch-content-right">
<div class="pytorch-right-menu" id="pytorch-right-menu">
<div class="pytorch-side-scroll" id="pytorch-side-scroll-right">
Expand All @@ -186,93 +148,32 @@
</section>
</div>

{% if not embedded %}
{%- block footer %} {% endblock %}

{% if sphinx_version >= "1.8.0" %}
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}
{% else %}
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'{{ url_root }}',
VERSION:'{{ release|e }}',
LANGUAGE:'{{ language }}',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
HAS_SOURCE: {{ has_source|lower }},
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
};
</script>
{%- for scriptfile in script_files %}
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
{%- endfor %}
{% endif %}
<!-- MOBILE MENU FOR SIDEBAR -->
<script type="text/javascript" id="documentation_options" data-url_root="{{ pathto('', 1) }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script>
{%- for scriptfile in script_files %}
{{ js_tag(scriptfile) }}
{%- endfor %}

{% endif %}
<script type="text/javascript" src="{{ pathto('_static/js/vendor/popper.min.js', 1) }}"></script>
<script type="text/javascript" src="{{ pathto('_static/js/vendor/bootstrap.min.js', 1) }}"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>

<script type="text/javascript" src="{{ pathto('_static/js/vendor/popper.min.js', 1) }}"></script>
<script type="text/javascript" src="{{ pathto('_static/js/vendor/bootstrap.min.js', 1) }}"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/list.js/1.5.0/list.min.js"></script>
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
<script type="text/javascript" src="{{ pathto('_static/js/vendor/anchor.min.js', 1) }}"></script>

<!-- enable language dropdown menu expand -->
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
});
jQuery(function () {
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }});
});
</script>

{%- block footer %} {% endblock %}

<div>
<br>
</div>

<!-- Begin Mobile Menu -->

<div class="mobile-main-menu">
<div class="container-fluid">
<div class="container">
<div class="mobile-main-menu-header-container">
<a class="header-logo" href="{{ theme_variables.external_urls['home'] }}" aria-label="PyTorch"></a>
<a class="main-menu-close-button" href="#" data-behavior="close-mobile-menu"></a>
</div>
</div>
</div>

<div class="mobile-main-menu-links-container">
<div class="main-menu">
<ul>
<li>
<a href="{{ theme_variables.external_urls['docs'] }}">Qiskit Documentation</a>
</li>

<li>
<a href="{{ theme_variables.external_urls['resources'] }}" target="_blank">Learning Resources</a>
</li>

<li>
<a href="{{ theme_variables.external_urls['slack'] }}" target="_blank">Slack Support</a>
</li>

<li>
<a href="{{ theme_variables.external_urls['github'] }}" target="_blank">Github</a>
</li>
</ul>
</div>
</div>
</div>

<!-- End Mobile Menu -->

<script type="text/javascript" src="{{ pathto('_static/js/vendor/anchor.min.js', 1) }}"></script>

<script type="text/javascript">
$(document).ready(function() {
mobileMenu.bind();
mobileTOC.bind();
pytorchAnchors.bind();
sideMenus.bind();
scrollToAnchor.bind();
highlightNavigation.bind();
Expand All @@ -285,5 +186,6 @@
});
})
</script>

</body>
</html>
14 changes: 0 additions & 14 deletions docs/source/_templates/page.html
View file

This file was deleted.

Loading

0 comments on commit 1bd168a

Please sign in to comment.