Skip to content

Commit

Permalink
Update Vestaboard API documentation links
Browse files Browse the repository at this point in the history
  • Loading branch information
jparise committed Jan 7, 2024
1 parent 8142ce8 commit 9df2a59
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ code (such as `{5}` or `{65}`).
#### `LocalClient`

`LocalClient` provides a client interface for interacting with a Vestaboard
over the local network using [Vestaboard's Local API](https://docs.vestaboard.com/local).
over the local network using [Vestaboard's Local API](https://docs.vestaboard.com/docs/local-api/introduction).

Note that Vestaboard owners must first request a
[Local API enablement token](https://www.vestaboard.com/local-api)
Expand All @@ -80,7 +80,7 @@ assert local_client.read_message() == message
#### `ReadWriteClient`

`ReadWriteClient` provides a client interface for interacting with a Vestaboard
using the [Read / Write API](https://docs.vestaboard.com/read-write).
using the [Read / Write API](https://docs.vestaboard.com/docs/read-write-api/introduction).

Note that Vestaboard owners must first obtain their Read / Write API key by
enabling the Vestaboard's Read / Write API via the Settings section of the
Expand All @@ -99,8 +99,8 @@ assert rw_client.read_message() == message
### Character Encoding

All Vestaboard characters (letters, numbers, symbols, and colors) are encoded
as integer [character codes](https://docs.vestaboard.com/characters). Vesta
includes some useful routines for working with these character codes.
as integer [character codes](https://docs.vestaboard.com/docs/characterCodes).
Vesta includes some useful routines for working with these character codes.

`encode()` encodes a string as a list of character codes. In addition to
printable characters, the string can contain character code sequences inside
Expand Down
9 changes: 5 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ API Clients

:py:class:`vesta.LocalClient` provides a client interface for interacting with
a Vestaboard over the local network using `Vestaboard's Local API
<https://docs.vestaboard.com/local>`_.
<https://docs.vestaboard.com/docs/local-api/introduction>`_.

.. important::

Expand All @@ -46,7 +46,8 @@ a Vestaboard over the local network using `Vestaboard's Local API
-------------------

:py:class:`vesta.ReadWriteClient` provides a client interface for interacting
with a Vestaboard using the `Read / Write API <https://docs.vestaboard.com/read-write>`_.
with a Vestaboard using the `Read / Write API
<https://docs.vestaboard.com/docs/read-write-api/introduction>`_.

.. important::

Expand All @@ -61,8 +62,8 @@ Character Encoding
==================

All Vestaboard characters (letters, numbers, symbols, and colors) are encoded
as integer `character codes <https://docs.vestaboard.com/characters>`_. Vesta
includes some helpful routines for working with these character codes.
as integer `character codes <https://docs.vestaboard.com/docs/characterCodes>`_.
Vesta includes some helpful routines for working with these character codes.

.. automodule:: vesta.chars
:members: COLS, ROWS, Row, Rows
Expand Down

0 comments on commit 9df2a59

Please sign in to comment.