Skip to content

Commit

Permalink
minor docs corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharyburnett committed May 24, 2024
1 parent eae42ac commit 46243e9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
11 changes: 6 additions & 5 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
except ImportError:
import tomli as tomllib


def repository_root(path: PathLike = None) -> Path:
if path is None:
path = __file__
Expand All @@ -21,6 +22,7 @@ def repository_root(path: PathLike = None) -> Path:
else:
return repository_root(path.parent)


# -- Path setup --------------------------------------------------------------
ROOT = repository_root()

Expand All @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``)
--------------------------
Expand Down

0 comments on commit 46243e9

Please sign in to comment.