diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index 7b859264..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,3 +0,0 @@ -D-Wave welcomes contributions to Ocean projects. - -See how to contribute at :std:doc:`Ocean Contributors `. diff --git a/README.rst b/README.rst index 29d7e040..d122c283 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,10 @@ .. image:: https://badge.fury.io/py/dwave-cloud-client.svg :target: https://badge.fury.io/py/dwave-cloud-client - :alt: Last version on PyPI + :alt: Latest version on PyPI -.. image:: https://travis-ci.org/dwavesystems/dwave-cloud-client.svg?branch=master - :target: https://travis-ci.org/dwavesystems/dwave-cloud-client - :alt: Linux/Mac build status +.. image:: https://circleci.com/gh/dwavesystems/dwave-cloud-client.svg?style=svg + :target: https://circleci.com/gh/dwavesystems/dwave-cloud-client + :alt: Linux/MacOS build status .. image:: https://ci.appveyor.com/api/projects/status/6a2wjq9xtgtr2t2c/branch/master?svg=true :target: https://ci.appveyor.com/project/dwave-adtt/dwave-cloud-client/branch/master @@ -65,7 +65,7 @@ Installation .. installation-start-marker -Requires Python 3.5+: +Requires Python 3.6+: .. code-block:: bash @@ -89,7 +89,28 @@ License Released under the Apache License 2.0. See ``_ file. -Contribution +Contributing ------------ -See ``_ file. +Ocean's `contributing guide `_ +has guidelines for contributing to Ocean packages. + +Release Notes +~~~~~~~~~~~~~ + +D-Wave Cloud Client uses `reno `_ to manage +its release notes. + +When making a contribution to D-Wave Cloud Client that will affect users, create +a new release note file by running + +.. code-block:: bash + + reno new your-short-descriptor-here + +You can then edit the file created under ``releasenotes/notes/``. +Remove any sections not relevant to your changes. +Commit the file along with your changes. + +See reno's `user guide `_ +for details. diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst deleted file mode 120000 index 798f2aa2..00000000 --- a/docs/CONTRIBUTING.rst +++ /dev/null @@ -1 +0,0 @@ -../CONTRIBUTING.rst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index df838aa2..d7f93a74 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,7 +36,8 @@ 'sphinx.ext.napoleon', 'sphinx.ext.todo', 'sphinx.ext.viewcode', - 'sphinx.ext.ifconfig' + 'sphinx.ext.ifconfig', + 'reno.sphinxext', ] # autodoc_default_flags = ['members'] diff --git a/docs/index.rst b/docs/index.rst index 5f437b96..ab229cdc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,6 +29,7 @@ Documentation intro reference/index bibliography + release_notes .. sdk-end-marker diff --git a/docs/release_notes.rst b/docs/release_notes.rst new file mode 100644 index 00000000..ec77acc3 --- /dev/null +++ b/docs/release_notes.rst @@ -0,0 +1 @@ +.. release-notes:: Release Notes diff --git a/docs/requirements.txt b/docs/requirements.txt index 69b6ed87..e7ec5651 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ sphinx>=4.0.0,<5.0.0 sphinx_rtd_theme +reno[sphinx]==3.4.0 diff --git a/releasenotes/notes/add-reno-a45ccf1f7e141857.yaml b/releasenotes/notes/add-reno-a45ccf1f7e141857.yaml new file mode 100644 index 00000000..57e31994 --- /dev/null +++ b/releasenotes/notes/add-reno-a45ccf1f7e141857.yaml @@ -0,0 +1,10 @@ +--- +prelude: > + We began using `Reno `_ as a changelog + tool after the release of 0.8.7. + Content added before that release is not included. + See `releases `_ + for previous release notes. +features: + - | + Begin using reno for changelog. diff --git a/requirements.txt b/requirements.txt index 1e7d5c2a..ba58d17d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,3 +8,6 @@ plucky>=0.4.3 # note: dqm supported in dimod>0.9.6 dimod>=0.10.5 numpy>=1.16 + +# dev requirements +reno==3.4.0