Skip to content

Commit 870b494

Browse files
authored
Merge pull request #59 from jasongrout/description
Update Pypi description to be the same as the readme
2 parents 944ccf4 + 19fabaf commit 870b494

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# JupyterLite Sphinx
22

3-
A Sphinx extension that provides utilities for embedding JupyterLite in your docs
3+
A Sphinx extension that provides utilities for embedding [JupyterLite](https://jupyterlite.readthedocs.io) in your documentation.
44

5-
### Docs
5+
## Docs
66

7-
https://jupyterlite-sphinx.readthedocs.io/en/latest
7+
https://jupyterlite-sphinx.readthedocs.io
88

9-
### Example
9+
## Example
1010

11-
A practical example is the ipycanvas documentation: https://ipycanvas.readthedocs.io/en/master
11+
Practical examples are in the [ipycanvas](https://ipycanvas.readthedocs.io) and [ipyleaflet](https://ipyleaflet.readthedocs.io) documentation.
1212

13-
### Installation:
13+
## Installation:
1414

1515
```bash
1616
pip install jupyterlite-sphinx

setup.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
from setuptools import setup
22

33

4+
from pathlib import Path
5+
this_directory = Path(__file__).parent
6+
long_description = (this_directory / "README.md").read_text()
7+
48
setup(
59
name='jupyterlite-sphinx',
610
version='0.4.9',
11+
long_description=long_description,
12+
long_description_content_type='text/markdown',
713
package_dir={'': 'src'},
814
py_modules=['jupyterlite_sphinx'],
915
python_requires='>=3.7',

0 commit comments

Comments
 (0)