Merge branch 'master' into davidfischer/declare-package-main

Author: ericholscher

README.rst

@@ -17,7 +17,7 @@ Read the Docs Sphinx Theme
   :alt: Documentation Status
 
 The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly.
-This theme is primary focused to be used on readthedocs.org_ but can work with your
+This theme is primarily focused to be used on readthedocs.org_ but can work with your
 own sphinx projects. To read more and see a working demo_ head over to readthedocs.org_.
 
 .. _sphinx: http://www.sphinx-doc.org

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "sphinx-rtd-theme",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "homepage": "https://github.com/rtfd/sphinx_rtd_theme",
   "authors": [
     "Dave Snider, Read the Docs, Inc. & contributors <[email protected]>"

docs/changelog.rst

@@ -3,9 +3,11 @@
 Changelog
 *********
 
-master
+v0.4.1
 ======
 
+:Date: July 27, 2018
+
 
 New Features
 -------------

docs/contributing.rst

@@ -80,7 +80,14 @@ you should do the following:
 #. Commit that change.
 #. Tag the release in git: ``git tag $NEW_VERSION``.
 #. Push the tag to GitHub: ``git push --tags origin``.
-#. Upload the package to PyPI: ``python setup.py sdist bdist_wheel upload``.
+#. Upload the package to PyPI:
+
+    .. code:: bash
+
+        $ rm -rf dist/
+        $ python setup.py sdist bdist_wheel
+        $ twine upload --sign --identity [email protected] dist/*
+
 #. In the ``readthedocs.org`` repo, edit the ``bower.json`` file to point at the correct version
    (``sphinx-rtd-theme": "https://github.com/rtfd/sphinx-rtd-theme.git#$NEW_VERSION"``).
 #. In the ``readthedocs.org`` repo, run ``gulp build`` to update the distributed theme files.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "sphinx_rtd_theme",
   "main": "js/theme.js",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "private": true,
   "devDependencies": {
     "bower": "^1.8.4",

sass/_theme_layout.sass

@@ -1,3 +1,7 @@
+// Set uniform (but not relative) base font size
+html
+  font-size: $base-font-size
+
 .wy-affix
   position: fixed
   top: $gutter

sphinx_rtd_theme/__init__.py

@@ -5,7 +5,7 @@
 """
 from os import path
 
-__version__ = '0.4.0'
+__version__ = '0.4.1'
 __version_full__ = __version__
 
 

sphinx_rtd_theme/footer.html

@@ -16,9 +16,9 @@
     <p>
     {%- if show_copyright %}
       {%- if hasdoc('copyright') %}
-        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}{% endtrans %}
       {%- else %}
-        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}{% endtrans %}
       {%- endif %}
     {%- endif %}
 

sphinx_rtd_theme/layout.html

@@ -188,20 +188,28 @@
 
   {% if not embedded %}
 
-    <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 %}
+    {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #}
+    {% 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 %}
 
   {% endif %}