-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
44 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Instructions for creating a new release | ||
|
||
Spinx-Copybutton is [hosted on the pypi repository](https://pypi.org/project/sphinx-copybutton/). | ||
To create a new release of Sphinx-Copybutton, you need to do these things: | ||
|
||
## Before you start | ||
|
||
1. Ensure that you have push access to the [Sphinx-Copybutton pypi repository](https://pypi.org/project/sphinx-copybutton/) | ||
2. Install [the twine package](https://twine.readthedocs.io/en/latest/). This is a package that helps you | ||
bundle and push new Python package distributions to pip. | ||
|
||
## To create the release | ||
|
||
To create a new release, [open an issue](https://github.com/choldgraf/sphinx-copybutton/issues/new) to keep | ||
track of the to-do list for the release. Copy/paste the following markdown into the issue | ||
and check off the boxes as you complete items: | ||
|
||
|
||
``` | ||
- [ ] Ensure that the [Sphinx-Copybutton version number](https://github.com/choldgraf/sphinx-copybutton/blob/master/jupyter_book/__init__.py) | ||
is correct, and remove the `dev0` part of the version number. | ||
Make a PR with the new number and merge into master. | ||
- [ ] Create a new distribution for Sphinx-Copybutton by | ||
[following the twine release instructions](https://twine.readthedocs.io/en/latest/#using-twine) | ||
- [ ] Confirm that the new version of Sphinx-Copybutton [is posted to pypi](https://pypi.org/project/sphinx-copybutton/) | ||
- [ ] Bump the [Sphinx-Copybutton version number](https://github.com/choldgraf/sphinx-copybutton/blob/master/jupyter_book/__init__.py) to | ||
the next minor (or major) release and append `dev0` to the end. | ||
- [ ] Celebrate! You've just released a new version of Sphinx-Copybutton! | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,23 @@ | ||
from setuptools import setup, find_packages | ||
from sphinx_copybutton import __version__ | ||
|
||
with open('./README.md', 'r') as ff: | ||
readme_text = ff.read() | ||
|
||
setup( | ||
name='sphinx-copybutton', | ||
version=__version__, | ||
description="Add a copy button to each of your code cells.", | ||
long_description=readme_text, | ||
author='Chris Holdgraf', | ||
author_email='choldgraf@gmail.com', | ||
author_email='choldgraf@berkeley.edu', | ||
url="https://github.com/choldgraf/sphinx-copybutton", | ||
license='BSD', | ||
packages=find_packages(), | ||
package_data={'sphinx_copybutton': ['_static/copybutton.css', | ||
'_static/copybutton.js', | ||
'_static/copy-button.svg']}, | ||
include_package_data=True, | ||
install_requires=["flit", "setuptools", "wheel", "sphinx"], | ||
classifiers=["License :: OSI Approved :: MIT License"] | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters