diff options
author | Benjamin Balder Bach <benjamin@overtag.dk> | 2022-08-20 01:48:58 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-20 01:48:58 +0300 |
commit | d343a1d4d493ec55e61592047458662e01602a3c (patch) | |
tree | fcf1b55cb3efb1ad58ee1cadf9d2bcb6bcfe972d | |
parent | 487d517bfc225d04c94e9c289fe095af21df4de4 (diff) | |
parent | 47a2582c5458081b8d18e01c0c9d3ab1265af7e7 (diff) |
Merge pull request #1321 from benjaoming/no-bumpversion-package-lock.json
Don't run bumpversion on package-lock.json
-rw-r--r-- | docs/contributing.rst | 7 | ||||
-rw-r--r-- | setup.cfg | 5 | ||||
-rw-r--r-- | setup.py | 56 |
3 files changed, 62 insertions, 6 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 9eedb03..e3366bf 100644 --- a/docs/contributing.rst +++ b/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``. @@ -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} @@ -93,4 +93,60 @@ setup( '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', + }, ) |