Skip to content

Commit

Permalink
docs: update for release and install
Browse files Browse the repository at this point in the history
  • Loading branch information
willeccles committed Nov 18, 2024
1 parent 9b19e7c commit 1b6d6cd
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
8 changes: 3 additions & 5 deletions docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
7 changes: 0 additions & 7 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 1b6d6cd

Please sign in to comment.