Merge pull request #7 from minrk/release-doc

add changelog.md, release.md, README badges

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changes in autodoc-traits
+
+## 0.1.0
+
+0.1.0 is the first stable release of autodoc-traits.
+It fixes compatibility with sphinx 4 from the previously published 0.1.0dev prerelease.
+
+### Merged PRs
+
+- add publish github action [#4](https://github.com/jupyterhub/autodoc-traits/pull/4) ([@minrk](https://github.com/minrk))
+- Remove unused import of deprecated PyClassmember [#3](https://github.com/jupyterhub/autodoc-traits/pull/3) ([@minrk](https://github.com/minrk))
+- Remove duplicates in documenting trait members [#1](https://github.com/jupyterhub/autodoc-traits/pull/1) ([@rkdarst](https://github.com/rkdarst))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/jupyterhub/autodoc-traits/graphs/contributors?from=2019-09-06&to=2021-10-22&type=c))
+
+[@betatim](https://github.com/search?q=repo%3Ajupyterhub%2Fautodoc-traits+involves%3Abetatim+updated%3A2019-09-06..2021-10-22&type=Issues) | [@minrk](https://github.com/search?q=repo%3Ajupyterhub%2Fautodoc-traits+involves%3Aminrk+updated%3A2019-09-06..2021-10-22&type=Issues) | [@rkdarst](https://github.com/search?q=repo%3Ajupyterhub%2Fautodoc-traits+involves%3Arkdarst+updated%3A2019-09-06..2021-10-22&type=Issues) | [@welcome](https://github.com/search?q=repo%3Ajupyterhub%2Fautodoc-traits+involves%3Awelcome+updated%3A2019-09-06..2021-10-22&type=Issues) | [@willingc](https://github.com/search?q=repo%3Ajupyterhub%2Fautodoc-traits+involves%3Awillingc+updated%3A2019-09-06..2021-10-22&type=Issues)

README.md

@@ -1,6 +1,11 @@
 # autodoc-traits
 
-Sphinx extension to autodocument configuration files using the [traitlets](https://github.com/ipython/traitlets) library
+[![Latest PyPI version](https://img.shields.io/pypi/v/autodoc-traits?logo=pypi)](https://pypi.python.org/pypi/autodoc-traits)
+[![GitHub](https://img.shields.io/badge/issue_tracking-github-blue?logo=github)](https://github.com/jupyterhub/autodoc-traits/issues)
+[![Discourse](https://img.shields.io/badge/help_forum-discourse-blue?logo=discourse)](https://discourse.jupyter.org/c/jupyterhub)
+[![Gitter](https://img.shields.io/badge/social_chat-gitter-blue?logo=gitter)](https://gitter.im/jupyterhub/jupyterhub)
+
+Sphinx extension to autodocument configuration files using the [traitlets](https://github.com/ipython/traitlets) library.
 
 ## Install
 

RELEASE.md

@@ -0,0 +1,43 @@
+# How to make a release
+
+`autodoc-traits` is a package [available on
+PyPI][pypi].
+These are instructions on how to make a release on PyPI.
+The PyPI release is done automatically by GitHub Actions when a tag is pushed.
+
+To follow these instructions, you need:
+
+- To have push rights to the [autodoc-traits GitHub
+  repository][repo].
+
+[pypi]: https://pypi.org/project/autodoc-traits
+[repo]: https://github.com/jupyterhub/autodoc-traits
+
+## Steps to make a release
+
+1. Checkout main and make sure it is up to date.
+
+   ```shell
+   ORIGIN=${ORIGIN:-origin} # set to the canonical remote, e.g. 'upstream' if 'origin' is not the official repo
+   git checkout main
+   git pull $ORIGIN main
+   ```
+
+1. Update [CHANGELOG.md](CHANGELOG.md). Doing this can be made easier with the
+   help of the
+   [choldgraf/github-activity](https://github.com/choldgraf/github-activity)
+   utility.
+
+1. Publish the new version with [tbump][]
+
+   ```
+   tbump 1.2.3
+   ```
+
+1. Reset the version to next.dev (e.g. 1.2.3 -> 1.3.0.dev)
+
+   ```
+   tbump --no-tag 1.3.0.dev
+   ```
+
+[tbump]: https://github.com/dmerejkowsky/tbump

autodoc_traits/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.1.0"
+__version__ = "1.0.0.dev"
 
 
 def setup(app, *args, **kwargs):

pyproject.toml

@@ -0,0 +1,26 @@
+[tool.tbump.version]
+current = "1.0.0.dev"
+
+# Example of a pep440 regexp.
+# Make sure this matches current_version before
+# using tbump
+regex = '''
+  (?P<major>\d+)
+  \.
+  (?P<minor>\d+)
+  \.
+  (?P<patch>\d+)
+  (?P<pre>((a|b|rc)\d+)|)
+  \.?
+  (?P<dev>(?<=\.)dev\d*|)
+  '''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "{new_version}"
+
+# For each file to patch, add a [[tool.tbump.file]] config
+# section containing the path of the file, relative to the
+# tbump.toml location.
+[[tool.tbump.file]]
+src = "autodoc_traits/__init__.py"