Skip to content

WIP: add long_description to setup.py #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

WIP: add long_description to setup.py #236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
250ecbb
add long_description to setup.py
basnijholt Dec 11, 2019
97a2b78
add gifs using an image tag
basnijholt Dec 11, 2019
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
18 changes: 16 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,23 @@ with built-in support for
Examples
--------

.. raw:: html
.. image:: https://user-images.githubusercontent.com/6897215/38739170-6ac7c014-3f34-11e8-9e8f-93b3a3a3d61b.gif
:height: 593px
:width: 292px
:scale: 80%


.. image:: https://user-images.githubusercontent.com/6897215/35219611-ac8b2122-ff73-11e7-9332-adffab64a8ce.gif
:height: 673px
:width: 607px
:scale: 50%


.. image:: https://user-images.githubusercontent.com/6897215/47256441-d6d53700-d480-11e8-8224-d1cc49dbdcf5.gif
:height: 208px
:width: 248px
:scale: 90%

<img src="https://user-images.githubusercontent.com/6897215/38739170-6ac7c014-3f34-11e8-9e8f-93b3a3a3d61b.gif" width='20%'> </img> <img src="https://user-images.githubusercontent.com/6897215/35219611-ac8b2122-ff73-11e7-9332-adffab64a8ce.gif" width='40%'> </img> <img src="https://user-images.githubusercontent.com/6897215/47256441-d6d53700-d480-11e8-8224-d1cc49dbdcf5.gif" width='20%'> </img>

.. not-in-documentation-end

Expand Down
5 changes: 5 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ def get_version_and_cmdclass(package_name):

version, cmdclass = get_version_and_cmdclass("adaptive")

with open("README.rst") as f:
readme = f.read()

install_requires = [
"scipy",
Expand All @@ -48,6 +50,8 @@ def get_version_and_cmdclass(package_name):
setup(
name="adaptive",
description="Adaptive parallel sampling of mathematical functions",
long_description=readme,
long_description_content_type="text/x-rst",
version=version,
python_requires=">=3.6",
url="https://adaptive.readthedocs.io/",
Expand All @@ -59,6 +63,7 @@ def get_version_and_cmdclass(package_name):
"Intended Audience :: Science/Research",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
],
packages=find_packages("."),
install_requires=install_requires,
Expand Down