Skip to content

Commit

Permalink
Remove outdated setuptools-rust from the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
althonos committed Dec 5, 2024
1 parent 3ee4b48 commit 6885c63
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 17 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -217,15 +217,13 @@ jobs:
uses: actions/setup-python@v2
with:
python-version: '3.10'
- name: Install build dependencies
run: pip install setuptools-rust
- name: Download built wheels
uses: actions/download-artifact@v2
with:
name: wheels
path: dist
- name: Extract package version
run: echo PKGVER=$(python setup.py --version) >> $GITHUB_ENV
run: echo PKGVER=$(echo ${{ github.ref }} | cut -dv -f2) >> $GITHUB_ENV
- name: Compute SHA256 of source distribution
run: echo SHA256=$(sha256sum dist/pyskani-${{ env.PKGVER }}.tar.gz | cut -f1 -d' ') >> $GITHUB_ENV
- name: Generate PKGBUILD
Expand Down
1 change: 0 additions & 1 deletion docs/changes.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/contributing.md

This file was deleted.

16 changes: 7 additions & 9 deletions docs/guide/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,18 @@ the repository and install the repository by running (with the admin rights):
which may not even build, so consider using a versioned release instead.


GitHub + ``setuptools``
^^^^^^^^^^^^^^^^^^^^^^^
GitHub + ``build``
^^^^^^^^^^^^^^^^^^

If you do not want to use ``pip``, you can still clone the repository and
run the ``setup.py`` file manually, although you will need to install the
build dependencies (mainly `setuptools-rust <https://pypi.org/project/setuptools-rust>`_)
and have a working Rust compiler setup:
use ``build`` and ``installer`` manually:

.. code:: console
$ git clone https://github.com/althonos/pyskani
$ cd pyskani
$ python setup.py build_ext
# python setup.py install
$ git clone --recursive https://github.com/althonos/pyskani
$ cd pyskani
$ python -m build .
# python -m installer dist/*.whl
.. Danger::

Expand Down
4 changes: 1 addition & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# build dependencies
setuptools >=46.4
setuptools-rust
maturin

# sphinx documentation dependencies
semantic_version ~=2.8
Expand Down

0 comments on commit 6885c63

Please sign in to comment.