Merge pull request #1321 from benjaoming/no-bumpversion-package-lock.json

Don't run bumpversion on package-lock.json

Author: benjaoming

docs/contributing.rst

@@ -184,8 +184,11 @@ To release a new version of the theme, core team will take the following steps:
 #. Update the changelog (``docs/changelog.rst``) with the version information.
 #. Run ``python setup.py update_translations`` to compile new translation files
    and update Transifex.
-#. Run ``python setup.py build_assets`` to rebuild all the theme assets and the Python
-   package.
+#. Run ``npm install && npm run build`` to rebuild all the theme assets,
+   notice that ``package-lock.json`` will be updated with a new package
+   version. But take care that it isn't also bumping versions of dependencies
+   in ways that are risky to the release. *If* ``package-lock.json`` changes, you
+   need to commit it to git and tag it together with your release.
 #. Commit these changes.
 #. Tag the release in git: ``git tag $NEW_VERSION``.
 #. Push the tag to GitHub: ``git push --tags origin``.

setup.cfg

@@ -43,6 +43,7 @@ dev =
   transifex-client
   sphinxcontrib-httpdomain
   bump2version
+  wheel
 
 [options.entry_points]
 sphinx.html_themes =
@@ -107,10 +108,6 @@ first_value = 1
 search = "version": "{current_version}",
 replace = "version": "{new_version}",
 
-[bumpversion:file:package-lock.json]
-search = "version": "{current_version}",
-replace = "version": "{new_version}",
-
 [bumpversion:file:docs/changelog.rst]
 search = .. |development_version| replace:: {current_version}
 replace = .. |development_version| replace:: {new_version}

setup.py

@@ -93,4 +93,60 @@ def run(self):
         'build_assets': WebpackBuildCommand,
         'watch': WebpackDevelopCommand,
     },
+    zip_safe=False,
+    packages=['sphinx_rtd_theme'],
+    package_data={'sphinx_rtd_theme': [
+        'theme.conf',
+        '*.html',
+        'static/css/*.css',
+        'static/css/fonts/*.*',
+        'static/js/*.js',
+    ]},
+    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',
+        ]
+    },
+    python_requires='>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*',
+    install_requires=[
+        'sphinx>=1.6',
+        'docutils<0.18',
+        'Jinja2<3.1',
+    ],
+    tests_require=[
+        'pytest',
+    ],
+    extras_require={
+        'dev': [
+            'transifex-client',
+            'sphinxcontrib-httpdomain',
+            'bump2version',
+            'wheel',
+        ],
+    },
+    classifiers=[
+        'Framework :: Sphinx',
+        'Framework :: Sphinx :: Theme',
+        'Development Status :: 5 - Production/Stable',
+        'License :: OSI Approved :: MIT License',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Operating System :: OS Independent',
+        'Topic :: Documentation',
+        'Topic :: Software Development :: Documentation',
+    ],
+    project_urls={
+        'Homepage': 'https://sphinx-rtd-theme.readthedocs.io/',
+        'Source Code': 'https://github.com/readthedocs/sphinx_rtd_theme',
+        'Issue Tracker': 'https://github.com/readthedocs/sphinx_rtd_theme/issues',
+    },
 )