diff options
| author | Adam Spiers <git@adamspiers.org> | 2018-05-17 00:46:01 +0100 |
|---|---|---|
| committer | Adam Spiers <git@adamspiers.org> | 2018-05-17 00:46:01 +0100 |
| commit | 7d1d71fd78915cbb5285f30a0869bc4418496e8c (patch) | |
| tree | aa22dbec08cbaaabb3c321e782c812fcd7024c49 /docs | |
| parent | a4670bb505512887f7689ee142e1592e4adf3cd5 (diff) | |
| download | git-deps-7d1d71fd78915cbb5285f30a0869bc4418496e8c.tar.gz | |
fix .rst formatting
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/maintainer-guide.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/maintainer-guide.rst b/docs/maintainer-guide.rst index 2c3a611..6428c4d 100644 --- a/docs/maintainer-guide.rst +++ b/docs/maintainer-guide.rst @@ -13,9 +13,9 @@ Initial setup - Create a PyPI account -- Configure `~/.pypirc` with credentials +- Configure ``~/.pypirc`` with credentials -- `pip install twine` +- ``pip install twine`` How to make a new release of git-deps @@ -25,20 +25,20 @@ How to make a new release of git-deps - Ensure all change have been pushed to the remote branch. -- Run `tox` to check everything is OK. +- Run ``tox`` to check everything is OK. - Decide a new version. Release candidates should take the form - `1.2.3rc4`. + ``1.2.3rc4``. -- `git tag -s $version` +- ``git tag -s $version`` -- `tox -e sdist` +- ``tox -e sdist`` -- `twine dist/git-deps-$version.tar.gz` +- ``twine dist/git-deps-$version.tar.gz`` - Check the new version appears at `<https://pypi.org/project/git-deps/>`_. - Test installation via at least one of the documented options, e.g. - `pip install git-deps` within a virtualenv. + ``pip install git-deps`` within a virtualenv. - Test / update the Docker-based installation. |