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.

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

Documentation loads jquery.js twice #26

Open
juliangilbey opened this issue Feb 11, 2021 · 3 comments
Open

Documentation loads jquery.js twice #26

juliangilbey opened this issue Feb 11, 2021 · 3 comments
Labels

Comments

@juliangilbey
Copy link

Looking at the source code generated by the doc build, and this is also the case on readthedocs.io, jquery.js is loaded twice - and two different versions at that!

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>plydata &#8212; plydata 0.4.3+2.gd9d022 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="_static/custom.css" />
    <link rel="stylesheet" type="text/css" href="https://assets.readthedocs.org/static/css/badge_only.css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <script src="_static/copybutton.js"></script>
    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script async="async" src="https://assets.readthedocs.org/static/javascript/readthedocs-doc-embed.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="API Reference" href="api.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<script type="text/javascript" src="_static/js/jquery-1.12.4.min.js "></script>
<script type="text/javascript" src="_static/js/jquery-fix.js "></script>
<script type="text/javascript" src="_static/bootstrap-3.4.1/js/bootstrap.min.js "></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js "></script>

Here, _static/jquery.js is included by the Sphinx build process. So I would suggest modifying doc/theme/layout.html to remove the line:

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

and remove the jquery-1.12.4.min.js from the sources.

The same applies to all of the packages in this repository.

Best wishes, Julian

@has2k1
Copy link
Owner

has2k1 commented Feb 11, 2021 via email

@juliangilbey
Copy link
Author

You're right - definitely load the jQuery from Sphinx (1.something, depending on the Sphinx version), otherwise the drop-down menus break.

Also, noticed that in plydata/doc/changelog.rst, lines 18-24 need to be indented by one more space or Sphinx complains.

@has2k1
Copy link
Owner

has2k1 commented Feb 17, 2022

This issue will be automatically resolved when sphinx 6.0 is released.

@has2k1 has2k1 added the wontfix label Feb 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants