diff --git a/docs/source/conf.py b/docs/source/conf.py index fac3e70..f239dba 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,7 +9,7 @@ project = "SPIKE™ Prime protocol" copyright = "2024, LEGO® Education" author = "LEGO® Education" -release = "0.1" +release = "1.0" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -23,6 +23,7 @@ extensions = [ "sphinx.ext.autosectionlabel", + "sphinx.ext.extlinks", "sphinx.ext.githubpages", "sphinx_rtd_theme", "role_enum", @@ -32,6 +33,13 @@ templates_path = ["_templates"] exclude_patterns = [] +extlinks = { + "repo": ( + "https://github.com/LEGO/spike-prime-docs/tree/main/%s", + "https://github.com/LEGO/spike-prime-docs/%s", + ), +} + # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/index.rst b/docs/source/index.rst index aa97765..eb29bfe 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,6 +6,11 @@ LEGO® Education SPIKE™ App 3 Prime hubs. It is intended for developers who want to write their own software to control the SPIKE™ Prime Hub over Bluetooth Low Energy (BLE). +Some sections include example implementations for reference, +written in Python. +The full source code is available in the repository at +:repo:`examples/python`. + .. toctree:: :caption: Topics :maxdepth: 1