Merge branch 'master' into blendify/kbd

Author: Blendify

.circleci/config.yml

@@ -6,10 +6,13 @@ commands:
     parameters:
       version:
         type: string
+      sphinx-version:
+        type: string
+        default: "16,17,18,20,21,22,23,24,30,31,32,33,34,latest"
     steps:
       - checkout
       - run: pip install --user tox
-      - run: tox -e "<<parameters.version>>-sphinx{16,17,18,20,21,22,23,24,30,31,32}"
+      - run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
 
 jobs:
   py27:

.github/ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE/bug_report.md

@@ -1,3 +1,11 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'Bug, Needed: replication'
+assignees: ''
+
+---
 
 ### Problem
 

docs/_templates/layout.html

@@ -1,16 +1,16 @@
 {%- extends "!layout.html" %}
 
-{#
+{#-
 
 This template exists as a way to implement a version menu without changing what
 the theme normally renders the menu on local builds and on builds on Read the
 Docs. This is for local testing purposes only.
 
 #}
 
-{% block footer %}
-  {% if not READTHEDOCS %}
-    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+{%- block footer %}
+  {%- if not READTHEDOCS %}
+    <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
       <span class="rst-current-version" data-toggle="rst-current-version">
         <span class="fa fa-book"> Read the Docs</span>
         v: latest
@@ -19,15 +19,15 @@
       <div class="rst-other-versions">
         <dl>
           <dt>{{ _('Versions') }}</dt>
-          {% if test_versions %}
-            {% for version in test_versions %}
+          {%- if test_versions %}
+            {%- for version in test_versions %}
             <dd><a href="#">{{ version }}</a></dd>
-            {% endfor %}
-          {% else %}
+            {%- endfor %}
+          {%- else %}
             <dd><a href="#">latest</a></dd>
             <dd><a href="#">1.0</a></dd>
             <dd><a href="#">1.1</a></dd>
-          {% endif %}
+          {%- endif %}
         </dl>
         <dl>
           <dt>{{ _('Downloads') }}</dt>
@@ -36,7 +36,7 @@
           <dd><a href="#">HTML</a></dd>
         </dl>
         <dl>
-          {# Translators: The phrase "Read the Docs" is not translated #}
+          {#- Translators: The phrase "Read the Docs" is not translated #}
           <dt>{{ _('On Read the Docs') }}</dt>
             <dd>
               <a href="#">{{ _('Project Home') }}</a>
@@ -51,5 +51,5 @@
         </dl>
       </div>
     </div>
-  {% endif %}
-{% endblock %}
+  {%- endif %}
+{%- endblock %}

docs/changelog.rst

@@ -5,16 +5,35 @@ Changelog
 master
 ======
 
-Other Changes
--------------
+v0.5.1
+======
+
+:Date: January 4, 2021
+
+Fixes
+-----
 
-* The ``canonical_url`` option was deprecated in favor of Sphinx's ``html_baseurl``.
+* Set ``url_root`` properly on index (#1025)
+* Do not load ``language_data.js`` in non-search pages (#1021)
+* Hide the search box on any ``singlehtml`` like builder (#975)
+* Fix ``vcs_pageview_mode`` template parameter (#1010)
+* Mark nex/prev icons as aria-hidden (#1007)
+* Use well-formed XML syntax (#1006)
+* Footer: show both ``commit`` and ``last_updated`` if available (#897)
+* Search page: don't show "edit on" links (#935)
 
 New Features
 ------------
 
 * New theme option to enable anonymous ip addresses when using Google Analytics (#889)
 
+Other Changes
+-------------
+
+* The ``canonical_url`` option was deprecated in favor of Sphinx's ``html_baseurl`` (#1003)
+* Add ``contentinfo`` block to ``footer.html`` template (#896)
+* Make Copyright template match sphinx's basic (#933)
+* Packaging: include ``bin/preinstall.js`` (#1005)
 
 v0.5.0
 ======

docs/conf.py

@@ -4,30 +4,18 @@
 import os
 import re
 
-# If we are building locally, or the build on Read the Docs looks like a PR
-# build, prefer to use the version of the theme in this repo, not the installed
-# version of the theme.
-def is_development_build():
-    # PR builds have an interger version
-    re_version = re.compile(r'^[\d]+$')
-    if 'READTHEDOCS' in os.environ:
-        version = os.environ.get('READTHEDOCS_VERSION', '')
-        if re_version.match(version):
-            return True
-        return False
-    return True
-
-if is_development_build():
-    sys.path.insert(0, os.path.abspath('..'))
+# Prefer to use the version of the theme in this repo
+# and not the installed version of the theme.
+sys.path.insert(0, os.path.abspath('..'))
 sys.path.append(os.path.abspath('./demo/'))
 
 import sphinx_rtd_theme
 from sphinx.locale import _
 
 project = u'Read the Docs Sphinx Theme'
 slug = re.sub(r'\W+', '-', project.lower())
-version = '0.5.0'
-release = '0.5.0'
+version = '0.5.1'
+release = '0.5.1'
 author = u'Dave Snider, Read the Docs, Inc. & contributors'
 copyright = author
 language = 'en'
@@ -52,8 +40,8 @@ def is_development_build():
 pygments_style = 'default'
 
 intersphinx_mapping = {
-    'rtd': ('https://docs.readthedocs.io/en/latest/', None),
-    'sphinx': ('http://www.sphinx-doc.org/en/stable/', None),
+    'rtd': ('https://docs.readthedocs.io/en/stable/', None),
+    'sphinx': ('https://www.sphinx-doc.org/en/stable/', None),
 }
 
 html_theme = 'sphinx_rtd_theme'

docs/contributing.rst

@@ -96,7 +96,7 @@ To release a new version of the theme, core team will take the following steps:
    (with regards to alpha release and development versions). The version
    increment should reflect these releases and any potentially breaking changes.
 #. New versions are by default ``alpha`` releases. If this is a release candidate,
-   run ``bump2version --allow-dirty releast`` to update the release to an ``rc``
+   run ``bump2version --allow-dirty release`` to update the release to an ``rc``
    release. If this is a final release, run the command again.
 #. Update the changelog (``docs/changelog.rst``) with the version information.
 #. Run ``python setup.py update_translations`` to compile new translation files

package-lock.json

@@ -1,8 +1,7 @@
 {
   "name": "sphinx_rtd_theme",
   "main": "js/theme.js",
-  "version": "0.5.0",
-  "private": true,
+  "version": "0.5.1",
   "scripts": {
     "dev": "webpack-dev-server --open --config webpack.dev.js",
     "build": "webpack --config webpack.prod.js",

package.json

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.5.0
+current_version = 0.5.1
 commit = false
 tag = false
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>[a-z]+)(?P<dev>\d+))?

setup.cfg

@@ -85,7 +85,7 @@ def run(self):
 
 setup(
     name='sphinx_rtd_theme',
-    version='0.5.0',
+    version='0.5.1',
     url='https://github.com/readthedocs/sphinx_rtd_theme',
     license='MIT',
     author='Dave Snider, Read the Docs, Inc. & contributors',