Skip to content

Commit

Permalink
Fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
nickw444 committed Nov 17, 2018
1 parent 6598418 commit d262f3b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,13 @@ A python implementation/abstraction of the [Ness D8x / D16x Serial Interface ASC
pip install nessclient
```

## Documentation

The full documentation can be found at [Read the Docs](https://nessclient.readthedocs.io/en/latest/)

## CLI

This package includes a CLI which uses the library to interface with the Ness Serial Interface. You can read more in [the docs]()
This package includes a CLI which uses the library to interface with the Ness Serial Interface. You can read more in [the docs](https://nessclient.readthedocs.io/en/latest/cli.html)

To use the CLI you must install it's dependencies by installing it with extras for `cli`:

Expand All @@ -26,12 +30,12 @@ ness-cli --help
```

## API Documentation
You can find the full API documentation [here]()
You can find the full API documentation [here](https://nessclient.readthedocs.io/en/latest/api.html)

## Examples

Please see [Examples]() section in the docs for examples. These same examples can be found as source in the [examples/](examples) directory.
Please see [Examples](https://nessclient.readthedocs.io/en/latest/examples.html) section in the docs for examples. These same examples can be found as source in the [examples/](examples) directory.

## Developing

Please see [Developing]() section in the docs for development environment setup information.
Please see [Developing](https://nessclient.readthedocs.io/en/latest/developing.html) section in the docs for development environment setup information.
8 changes: 8 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@

A python implementation/abstraction of the [Ness D8x / D16x Serial Interface ASCII protocol](http://www.nesscorporation.com/Software/Ness_D8-D16_ASCII_protocol.pdf)

## Installing nessclient

`nessclient` is available directly from pip:

```sh
pip install nessclient
```

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down

0 comments on commit d262f3b

Please sign in to comment.