aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/maintainer-guide.rst16
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.