Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/python-wheels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ name: Python wheels
on:
push:
branches: [master]
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'README.md']
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'tools/check_api_docs.py', 'tools/check_haskell_doc_examples.py', 'tools/check_docs_links.py', 'tools/haskell_reference.py', 'README.md']
pull_request:
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'README.md']
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'tools/check_api_docs.py', 'tools/check_haskell_doc_examples.py', 'tools/check_docs_links.py', 'tools/haskell_reference.py', 'README.md']
workflow_call:
outputs:
version:
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/validate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ name: Validate
on:
push:
branches: [master]
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'README.md']
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'tools/check_api_docs.py', 'tools/check_haskell_doc_examples.py', 'tools/check_docs_links.py', 'tools/haskell_reference.py', 'README.md']
pull_request:
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'README.md']
paths-ignore: ['docs/**', 'mkdocs.yml', 'requirements-docs.txt', 'tools/build_docs.py', 'tools/check_api_docs.py', 'tools/check_haskell_doc_examples.py', 'tools/check_docs_links.py', 'tools/haskell_reference.py', 'README.md']
workflow_dispatch:
inputs:
full-matrix:
Expand Down
15 changes: 5 additions & 10 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,39 +15,34 @@ library are not needed for normal Python use.
Use the interpreter belonging to your project or IDE environment:

```sh
python -m pip install --upgrade pip
python -m pip install --upgrade --only-binary=:all: "hmath-python>=1.0.1"
pip install hmath-python
python -c "from hmath import add; print(add(2, 3))"
```

The expected result is `5.0`. The distribution name is `hmath-python`;
the import name is `hmath`.

`--only-binary=:all:` makes unsupported platforms fail with a package-selection
error instead of unexpectedly attempting a source build.

For a new environment:

```sh
python -m venv .venv
. .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install --only-binary=:all: "hmath-python>=1.0.1"
pip install hmath-python
```

## Optional integrations

```sh
python -m pip install --upgrade --only-binary=:all: "hmath-python[numpy,cffi]>=1.0.1"
pip install "hmath-python[numpy,cffi]"
```

NumPy enables array conversion and zero-copy views. The `hmath_cffi` module
provides an alternative cffi wrapper; the default `hmath` module uses ctypes.

## Upgrade from 1.0.0

Version 1.0.0 shipped Python wrappers without the native library. Upgrade using
the command above. Do not copy a random `libhmath.so` into your system library
Version 1.0.0 shipped Python wrappers without the native library. For an existing
installation, run `pip install --upgrade hmath-python` in that environment. Do not copy a random `libhmath.so` into your system library
directory. If `HMATH_LIBRARY` was set as an earlier workaround, remove that
override to let the fixed wheel load its own library.

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The 1.0.0 Python distribution omitted the native library. Upgrade to 1.0.1
or newer using your application's interpreter:

```sh
python -m pip install --upgrade --only-binary=:all: "hmath-python>=1.0.1"
pip install --upgrade hmath-python
```

In PyCharm, use the interpreter selected in the project's Python interpreter
Expand Down
Loading
Loading