From 1b6d6cda57370922d86269463a2262fa19f7cd17 Mon Sep 17 00:00:00 2001 From: Will Eccles Date: Mon, 18 Nov 2024 13:19:01 -0500 Subject: [PATCH] docs: update for release and install --- docs/development.rst | 8 +++----- docs/installation.rst | 7 ------- 2 files changed, 3 insertions(+), 12 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index 7873869..c384940 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -52,10 +52,8 @@ Creating a New Release - Always release from the ``main`` branch. - Update the version, either using ``hatch version`` or by manually editing ``__init__.py``. -- Build distribution package: ``python -m build``. - -.. todo:: - - Finish this documentation when release packaging/uploading is sorted out. +- To build distribution package: ``python -m build``. +- To create a release and publish to PyPI, push a tag to the ``main`` branch. + Make sure you have updated the version appropriately first! .. _venv: https://docs.python.org/3/library/venv.html diff --git a/docs/installation.rst b/docs/installation.rst index 2e575c3..3e086de 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,13 +1,6 @@ Installation ============ -.. attention:: - This library is not yet hosted on PyPI, so the instructions below will not - work yet. For the time being, install from the wheel which can be downloaded - from the latest release:: - - $ pip install absscpi-[version]-py3-none-any.whl - Install the ``absscpi`` package from PyPI with ``pip`` or similar:: $ pip install absscpi