Skip to content

Commit

Permalink
update reference to API docs site (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
edaniszewski committed Apr 12, 2018
1 parent cd664a5 commit ee6f566
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This makes it possible to read from, write to, get metainfo, and scan for device
multiple back-ends all through a cURL-able interface.

For more detailed information on Synse Server, its API, and how to develop with it, see
the [User Guide][user-guide].
the [User Guide][user-guide] and the [API Documentation][synse-api].

## The Synse Ecosystem
Synse Server is one component of the greater Synse Ecosystem.
Expand Down Expand Up @@ -118,7 +118,7 @@ issue or open a new one. This project follows the typical [GitHub Workflow][gh-w
Synse Server is released under the [GPL-2.0](LICENSE) license.


[synse-api]: http://synse-server.readthedocs.io/en/latest/user/api.html
[synse-api]: https://vapor-ware.github.io/synse-server/
[synse-cli]: https://github.com/vapor-ware/synse-cli
[synse-dockerhub]: https://hub.docker.com/r/vaporio/synse-server/
[synse-emulator]: https://github.com/vapor-ware/synse-emulator-plugin
Expand Down
10 changes: 8 additions & 2 deletions docs/source/user/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,19 @@

API Reference
=============
The API docs are not currently hosted. To build and view them locally, clone the
repo and run
The Synse Server `API Documentation <https://vapor-ware.github.io/synse-server/>`_ is hosted
on GitHub pages. The source for it lives in the ``docs/api`` directory and can be build locally
as well, if desired.

.. code-block:: bash
# build the docs
make docs
This will create ``docs/index.html``, which can also be opened with

.. code-block:: bash
# view the docs
make api-docs

0 comments on commit ee6f566

Please sign in to comment.