diff options
| author |   efiacor <fiachra.corcoran@est.tech> | 2022-10-25 11:46:34 +0100 |
|---|---|---|
| committer |   Michael Morris <michael.morris@est.tech> | 2022-10-27 14:16:14 +0000 |
| commit | 248a9f1c153333002df39567e33fd5fa6092a62b (patch) | |
| tree | 4ce527613327984d9c7cb13108ab11fde8cea3f9 /docs/sections/offeredapis.rst | |
| parent | cb2663200092725c96240548e8fa046575530703 (diff) | |
[SDC-DIST-CLIENT] Add new RTD entry
Update README etc
Signed-off-by: efiacor <fiachra.corcoran@est.tech>
Change-Id: I4f92684e82d3fc2df978af12100be0871b94178d
Issue-ID: DMAAP-1792
Diffstat (limited to 'docs/sections/offeredapis.rst')
| -rw-r--r-- | docs/sections/offeredapis.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst new file mode 100644 index 0000000..7e59f76 --- /dev/null +++ b/docs/sections/offeredapis.rst @@ -0,0 +1,18 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright (C) 2022 Nordix Foundation + +.. _api_docs: + +Offered APIs +============ + +The api javadocs for interfaces provided by the sdc distribution client can be compiled by building the project. + +See :ref:`build steps<Build Steps>` for more information. + +The javadocs can be then found under the ``sdc-distribution-client/target/apidocs`` folder. + +The main interface that must be implemented by clients is the IConfiguration interface. + +See the :ref:`configuration section<config>` configuration section for more details. |