diff --git a/docs/source/conf.py b/docs/source/conf.py index c999c36d..ad2d5fa2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,6 +9,7 @@ except ImportError: import tomli as tomllib + def repository_root(path: PathLike = None) -> Path: if path is None: path = __file__ @@ -21,6 +22,7 @@ def repository_root(path: PathLike = None) -> Path: else: return repository_root(path.parent) + # -- Path setup -------------------------------------------------------------- ROOT = repository_root() @@ -33,15 +35,14 @@ def repository_root(path: PathLike = None) -> Path: project = metadata["name"] author = ", ".join(metadata["authors"]) -copyright = ", ".join(f"{datetime.now():%Y-%m-%d}, {author}" for author in metadata["authors"]) +copyright = ", ".join( + f"{datetime.now():%Y-%m-%d}, {author}" for author in metadata["authors"] +) version = metadata["version"] release = version # -- General configuration --------------------------------------------------- -extensions = [ - "sphinx_mdinclude", - "sphinx_rtd_theme" -] +extensions = ["sphinx_mdinclude", "sphinx_rtd_theme"] # -- Options for HTML output ------------------------------------------------- html_theme = "sphinx_rtd_theme" diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst index 98ec5958..df086ec0 100644 --- a/docs/source/configuration.rst +++ b/docs/source/configuration.rst @@ -63,8 +63,8 @@ connections from which to retrieve telemetry - path: ~/packets.txt .. note:: - To define a connection with no options (i.e. the ``sondehub`` entry, above), use YAML's empty flow mapping syntax ``sondehub: {}``. - The empty block mapping syntax (``sondehub: ``) is equivalent to ``sondehub: null`` and will not initiate the connection. + To define a connection without specifying options (or to use the default options), use empty curly braces: ``sondehub: {}``. + An empty string, i.e. ``sondehub:``, will not start the connection (it's equivalent to ``sondehub: null`` ). Text connection (``text``) --------------------------