Merge pull request #425 from segevfiner/setuptools-entry-points

Added setuptools entry point for Sphinx
readthedocs · Jun 26, 2017 · b3225c5 · b3225c5
2 parents 1dc21db + 31d410f
commit b3225c5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -46,6 +46,12 @@ In your ``conf.py`` file:
     html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
+or (since v0.2.5):
+
+.. code:: python
+
+    html_theme = "sphinx_rtd_theme"
+
 Via git or download
 -------------------
 
@@ -111,6 +117,8 @@ master
 * Add language to the JS output variable
 * Include the lato italics font with the theme
 * Fix padding on field lists
+* Add setuptools entry point allowing to use ``sphinx_rtd_theme`` as
+  Sphinx ``html_theme`` directly.
 
 v0.2.4
 ------

diff --git a/setup.py b/setup.py
@@ -27,6 +27,12 @@
         'static/font/*.*'
     ]},
     include_package_data=True,
+    # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
+    entry_points = {
+        'sphinx.html_themes': [
+            'sphinx_rtd_theme = sphinx_rtd_theme',
+        ]
+    },
     classifiers=[
         'Development Status :: 5 - Production/Stable',
         'License :: OSI Approved :: MIT License',