Skip to content

Commit

Permalink
Change project name
Browse files Browse the repository at this point in the history
  • Loading branch information
sorru94 committed Jul 18, 2024
1 parent 41bac80 commit 9bdabf9
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 18 deletions.
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,4 @@
# SDK documentation
# Astarte device SDKs documentation

This repository contains documentation regarding the architecture and supported features for each
of the Astarte device libraries (from now on called SDK).

## Generic SDK features

| Identifier | Name | Description |
| ---------- | --------------------------- | --------------------------------------------------- |
| **CR.01** | Registration from JWT | It should be possible to register a new device using a cached JWT at runtime |
| **CR.02** | Device ID and credential secret | The SDK shoul be able to connect to an Astarte instance using a cached device ID and credential secret |

Taken from [here](https://docs.google.com/spreadsheets/d/1E9YmG0yfT9kW0Du7GjQEN7-8JgFFg-GCkm8t8MBcT60/edit#gid=0)
4 changes: 1 addition & 3 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'sdk-doc'
project = 'astarte-device-sdk-doc'
copyright = '2024, Simone Orru'
author = 'Simone Orru'
release = '0'
Expand All @@ -19,8 +19,6 @@
templates_path = ['_templates']
exclude_patterns = []



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

Expand Down
7 changes: 2 additions & 5 deletions source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
.. sdk-doc documentation master file, created by
sphinx-quickstart on Thu Jul 18 11:56:38 2024.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. astarte-device-sdk-doc documentation master file.
sdk-doc documentation
Astarte device SDKs
=====================

Add your content using ``reStructuredText`` syntax. See the
Expand Down

0 comments on commit 9bdabf9

Please sign in to comment.