Merge branch 'master' into master

Author: RDIL

.gitignore

@@ -9,10 +9,17 @@
 *.map
 .ropeproject/
 .ruby-version
+bin/
 dist/
 bower_components/
+include/
+lib/
+local/
 node_modules
 npm-debug.log
 package-lock.json
+pip-selfcheck.json
 sphinx_rtd_theme/static/fonts/Lato/
 sphinx_rtd_theme/static/fonts/RobotoSlab/
+.python-version
+.node-version

.readthedocs.yml

@@ -1,5 +1,5 @@
-build:
-  image: latest
+version: 2
 python:
   version: 3.6
-requirements_file: docs/requirements.txt
+  install:
+    - requirements: docs/requirements.txt

.travis.yml

@@ -10,6 +10,7 @@ matrix:
       env: TOXENV=docs
 install:
   - pip install tox-travis
+  - pip install sphinx
 script:
   - tox
 

.tx/config

@@ -0,0 +1,8 @@
+[sphinx-rtd-theme.sphinx-rtd-theme]
+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
+
+[main]
+host = https://www.transifex.com
+type = PO

Gruntfile.js

@@ -1,4 +1,5 @@
 include *.txt
+include babel.cfg
 include LICENSE
 recursive-include sphinx_rtd_theme *.conf
 recursive-include sphinx_rtd_theme *.css
@@ -9,5 +10,7 @@ recursive-include sphinx_rtd_theme *.svg
 recursive-include sphinx_rtd_theme *.ttf
 recursive-include sphinx_rtd_theme *.woff
 recursive-include sphinx_rtd_theme *.woff2
+recursive-include sphinx_rtd_theme/locale *.pot *.po *.mo
 recursive-include tests *.py
 recursive-include tests *.rst
+prune build

MANIFEST.in

@@ -1,13 +1,12 @@
-
 **************************
 Read the Docs Sphinx Theme
 **************************
 
 .. image:: https://img.shields.io/pypi/v/sphinx_rtd_theme.svg
    :target: https://pypi.python.org/pypi/sphinx_rtd_theme
-   :alt: Pypi Version 
-.. image:: https://travis-ci.org/rtfd/sphinx_rtd_theme.svg?branch=master
-   :target: https://travis-ci.org/rtfd/sphinx_rtd_theme
+   :alt: Pypi Version
+.. image:: https://travis-ci.org/readthedocs/sphinx_rtd_theme.svg?branch=master
+   :target: https://travis-ci.org/readthedocs/sphinx_rtd_theme
    :alt: Build Status
 .. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
    :target: https://pypi.python.org/pypi/sphinx_rtd_theme/
@@ -16,39 +15,56 @@ Read the Docs Sphinx Theme
   :target: http://sphinx-rtd-theme.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status
 
-The ``sphinx_rtd_theme`` is a sphinx_ theme designed to look modern and be mobile-friendly.
-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_.
+This Sphinx_ theme was designed to provide a great reader experience for
+documentation users on both desktop and mobile devices. This theme is used
+primarily on `Read the Docs`_ but can work with any Sphinx project. You can find
+a working demo of the theme in the `theme documentation`_
 
-.. _sphinx: http://www.sphinx-doc.org
-.. _readthedocs.org: http://www.readthedocs.org
-.. _demo: https://sphinx-rtd-theme.readthedocs.io/en/latest/
+.. _Sphinx: http://www.sphinx-doc.org
+.. _Read the Docs: http://www.readthedocs.org
+.. _theme documentation: https://sphinx-rtd-theme.readthedocs.io/en/latest/
 
+Installation
+============
 
-Installing
-==========
+This theme is distributed on PyPI_ and can be installed with ``pip``:
 
-The theme is distributed on PyPI_ and can be installed with pip::
+.. code:: console
 
    pip install sphinx-rtd-theme
 
-For more information read the full installing docs
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html>`__.
+To use the theme in your Sphinx project, you will need to add the following to
+your ``conf.py`` file:
 
-.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
+.. code:: python
+
+    import sphinx_rtd_theme
+
+    extensions = [
+        ...
+        "sphinx_rtd_theme",
+    ]
 
+    html_theme = "sphinx_rtd_theme"
+
+For more information read the full documentation on `installing the theme`_
+
+.. _PyPI: https://pypi.python.org/pypi/sphinx_rtd_theme
+.. _installing the theme: https://sphinx-rtd-theme.readthedocs.io/en/latest/installing.html
 
 Configuration
 =============
 
-The ``sphinx_rtd_theme`` is highly customizable on both the page level and on a global level.
-To see all the possible configuration options read the configuring docs
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/configuring.html>`__.
+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
 
 Contributing
 ============
 
-If you would like to help improve the theme or have more control
-over the theme in case of a fork please read our contributing guide
-`here <https://sphinx-rtd-theme.readthedocs.io/en/latest/contributing.html>`__.
+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

README.rst

@@ -0,0 +1,10 @@
+# How setup this file
+# http://babel.pocoo.org/en/latest/setup.html
+# this file description:
+# http://babel.pocoo.org/en/latest/messages.html#extraction-method-mapping-and-configuration
+
+# Extraction from Jinja2 HTML templates
+[jinja2: **/**.html]
+encoding = utf-8
+ignore_tags = script,style
+include_attrs = alt title summary placeholder