Skip to content

Commit 1b6d6cd

Browse files
committed
docs: update for release and install
1 parent 9b19e7c commit 1b6d6cd

File tree

2 files changed

+3
-12
lines changed

2 files changed

+3
-12
lines changed

docs/development.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@ Creating a New Release
5252
- Always release from the ``main`` branch.
5353
- Update the version, either using ``hatch version`` or by manually editing
5454
``__init__.py``.
55-
- Build distribution package: ``python -m build``.
56-
57-
.. todo::
58-
59-
Finish this documentation when release packaging/uploading is sorted out.
55+
- To build distribution package: ``python -m build``.
56+
- To create a release and publish to PyPI, push a tag to the ``main`` branch.
57+
Make sure you have updated the version appropriately first!
6058

6159
.. _venv: https://docs.python.org/3/library/venv.html

docs/installation.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
Installation
22
============
33

4-
.. attention::
5-
This library is not yet hosted on PyPI, so the instructions below will not
6-
work yet. For the time being, install from the wheel which can be downloaded
7-
from the latest release::
8-
9-
$ pip install absscpi-[version]-py3-none-any.whl
10-
114
Install the ``absscpi`` package from PyPI with ``pip`` or similar::
125

136
$ pip install absscpi

0 commit comments

Comments
 (0)