Skip to content

Commit b325586

Browse files
Add Read the Docs URL
1 parent 812e131 commit b325586

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Now you can install the package and run your python code
5656
urllib3 1.26.4
5757
```
5858

59-
### Install with pip
59+
### Install from PyPI
6060

6161
```bash
6262
$ pip install pyedgeconnect
@@ -96,7 +96,11 @@ following syntax:
9696

9797
## Docs
9898

99-
To build the documentation, clone the repository, install with ``[dev]`` option
99+
[![Documentation Status](https://readthedocs.org/projects/pyedgeconnect/badge/?version=latest)](https://pyedgeconnect.readthedocs.io/en/latest/?badge=latest)
100+
101+
Docs are viewable on [Read the Docs](https://pyedgeconnect.readthedocs.io)
102+
103+
To build the documentation locally, clone the repository, install with ``[dev]`` option
100104
to include sphinx and related packages, then in the docs directory run ``make html``
101105

102106
```bash

0 commit comments

Comments
 (0)