Skip to content

Commit fce93dd

Browse files
Update description for wheel package (#20)
* Update description for wheel package * Move description from setup.py to README
1 parent e68998a commit fce93dd

File tree

3 files changed

+21
-12
lines changed

3 files changed

+21
-12
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,21 @@
33

44
See the [blog](https://software.intel.com/en-us/blogs/2018/10/18/mkl-service-package-controlling-mkl-behavior-through-python-interfaces) announcing the release.
55

6-
To install the package, use `conda install -c intel mkl-service`, or `conda install -c conda-forge mkl-service`.
6+
---
7+
8+
To install conda package, use `conda install -c intel mkl-service`, or `conda install -c conda-forge mkl-service`.
9+
10+
To install pypi package, use `python -m pip install mkl-service`
11+
12+
---
13+
14+
Intel(R) Math Kernel Library support functions are subdivided into the following groups according to their purpose:
15+
- Version Information
16+
- Threading Control
17+
- Timing
18+
- Memory Management
19+
- Conditional Numerical Reproducibility Control
20+
- Miscellaneous
721

822
A short example, illustrating it use:
923

conda-recipe/meta.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{% set version = "2.3.0" %}
1+
{% set version = "2.4.0" %}
22
{% set buildnumber = 0 %}
33

44
package:

setup.py

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@
3636
with io.open('mkl/__init__.py', 'rt', encoding='utf8') as file:
3737
VERSION = re.search(r'__version__ = \'(.*?)\'', file.read()).group(1)
3838

39+
with open("README.md", "r", encoding="utf-8") as file:
40+
long_description = file.read()
41+
3942
CLASSIFIERS = """\
4043
Development Status :: 5 - Production/Stable
4144
Intended Audience :: Science/Research
@@ -132,16 +135,8 @@ def setup_package():
132135
maintainer="Intel",
133136
maintainer_email="[email protected]",
134137
description="MKL Support Functions",
135-
long_description="""
136-
Intel(R) Math Kernel Library (Intel(R) MKL) support functions are
137-
subdivided into the following groups according to their purpose:
138-
Version Information
139-
Threading Control
140-
Timing
141-
Memory Management
142-
Conditional Numerical Reproducibility Control
143-
Miscellaneous
144-
""",
138+
long_description=long_description,
139+
long_description_content_type="text/markdown",
145140
url="https://github.com/IntelPython/mkl-service",
146141
author="Intel",
147142
download_url="https://github.com/IntelPython/mkl-service",

0 commit comments

Comments
 (0)