Merge branch 'master' of github.com:readthedocs/sphinx_rtd_theme into…

… HEAD

.circleci/config.yml

@@ -1,5 +1,8 @@
 version: 2.1
 
+orbs:
+  node: circleci/node@5.0.2
+
 commands:
   run-tox:
     description: "Run tox"
@@ -8,13 +11,35 @@ commands:
         type: string
       sphinx-version:
         type: string
-        default: "16,17,18,20,21,22,23,24,30,31,32,33,34,latest"
+        default: "16,17,18,20,21,22,23,24,30,31,32,33,34,35,40,41,latest"
     steps:
       - checkout
       - run: pip install --user tox
       - run: tox -e "<<parameters.version>>-sphinx{<<parameters.sphinx-version>>}"
+  run-build:
+    description: "Ensure built assets are up to date"
+    steps:
+      - checkout
+      - node/install:
+          node-version: '14.20'
+      - run: npm ci
+      - run: npm run build
+      - run:
+          name: Ensure built assets are up to date
+          command: |
+            if [[ `git status sphinx_rtd_theme/ --porcelain` ]]
+            then
+              echo "ERROR: assets are out of date. Make sure to run 'npm run build' on your branch."
+              git status sphinx_rtd_theme/ --porcelain
+              exit 1
+            fi
 
 jobs:
+  build:
+    docker:
+      - image: 'cimg/python:3.9-node'
+    steps:
+      - run-build: {}
   py27:
     docker:
       - image: 'cimg/python:2.7'
@@ -50,8 +75,19 @@ workflows:
   version: 2
   tests:
     jobs:
-      - py39
-      - py38
-      - py37
-      - py36
-      - py27
+      - build
+      - py39:
+          requires:
+            - build
+      - py38:
+          requires:
+            - build
+      - py37:
+          requires:
+            - build
+      - py36:
+          requires:
+            - build
+      - py27:
+          requires:
+            - build

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @readthedocs/theme

.gitignore

@@ -21,5 +21,9 @@ sphinx_rtd_theme/static/fonts/Lato/
 sphinx_rtd_theme/static/fonts/RobotoSlab/
 .python-version
 .node-version
+.tool-versions
+.nvmrc
 sphinx_rtd_theme/static/js/html5shiv.min.js
 sphinx_rtd_theme/static/js/html5shiv-printshiv.min.js
+.direnv/
+.envrc

.tx/config

@@ -2,7 +2,7 @@
 file_filter = sphinx_rtd_theme/locale/<lang>/LC_MESSAGES/sphinx.po
 source_file = sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.po
 source_lang = en
-minimum_perc = 90
+minimum_perc = 60
 
 [main]
 host = https://www.transifex.com

README.rst

@@ -22,7 +22,7 @@ a working demo of the theme in the `theme documentation`_
 
 .. _Sphinx: http://www.sphinx-doc.org
 .. _Read the Docs: http://www.readthedocs.org
-.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/
+.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/stable/
 
 Installation
 ============
@@ -33,24 +33,28 @@ This theme is distributed on PyPI_ and can be installed with ``pip``:
 
    $ pip install sphinx-rtd-theme
 
-To use the theme in your Sphinx project, you will need to add the following to
-your ``conf.py`` file:
+To use the theme in your Sphinx project, you will need to edit
+your ``conf.py`` file's ``html_theme`` setting:
 
 .. code:: python
 
-    import sphinx_rtd_theme
+    html_theme = "sphinx_rtd_theme"
 
-    extensions = [
-        ...
-        "sphinx_rtd_theme",
-    ]
+.. admonition:: See also:
 
-    html_theme = "sphinx_rtd_theme"
+    `Supported browsers`_
+        Officially supported and tested browser/operating system combinations
+
+    `Supported dependencies`_
+        Supported versions of Python, Sphinx, and other dependencies.
 
-For more information read the full documentation on `installing the theme`_
+    `Example documentation`_
+        A full example of this theme output, with localized strings enabled.
 
 .. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
-.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html
+.. _Supported browsers: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-browsers
+.. _Supported dependencies: https://sphinx-rtd-theme.readthedocs.io/en/stable/development.html#supported-dependencies
+.. _Example documentation:  https://sphinx-rtd-theme.readthedocs.io/en/stable/
 
 Configuration
 =============
@@ -59,12 +63,12 @@ This theme is highly customizable on both the page level and on a global level.
 To see all the possible configuration options, read the documentation on
 `configuring the theme`_.
 
-.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html
+.. _configuring the theme: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html
 
 Contributing
 ============
 
 If you would like to help modify or translate the theme, you'll find more
 information on contributing in our `contributing guide`_.
 
-.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html
+.. _contributing guide: https://sphinx-rtd-theme.readthedocs.io/en/stable/contributing.html