fix broken code and link in doc generation

opencybersecurityalliance · Oct 13, 2023 · 3048038 · 3048038
1 parent 4498947
commit 3048038
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,11 +1,10 @@
-import os
-from configparser import RawConfigParser
+import tomllib
 
 def get_version():
-    """Return package version from setup.cfg."""
-    config = RawConfigParser()
-    config.read(os.path.join("..", "setup.cfg"))
-    return config.get("metadata", "version")
+    """Use the kestrel_jupyter (umbralla package) version as doc version"""
+    with open("../packages/kestrel_jupyter/pyproject.toml", "rb") as f:
+        pyproject_config = tomllib.load(f)
+    return pyproject_config["project"]["version"]
 
 project = "Kestrel Threat Hunting Language"
 version = get_version()

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -17,7 +17,7 @@ configuration of STIX-shifter data sources.
 Default Kestrel Configuration
 =============================
 
-.. literalinclude:: ../src/kestrel/config.yaml
+.. literalinclude:: ../packages/kestrel_core/src/kestrel/config.yaml
    :language: yaml
 
 Example of User-Defined Configurations

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -65,9 +65,10 @@ The results have two parts:
 Kestrel + Jupyter
 =================
 
-To develop a hunt flow using Jupyter Notebook, you need to first follow the
-instructions in :ref:`installation/runtime:Kestrel Front-End Setup` to install
-the Kestrel Jupyter Notebook kernel if you haven't done so.
+Jupyter is one of the three default Kestrel front-ends. Follow
+:ref:`installation/runtime:Kestrel Runtime Installation` and
+:ref:`installation/runtime:Kestrel Front-Ends` to install the Kestrel Jupyter
+kernel and start your interactive hunt in Jupyter.
 
 Creating A Hunt Book
 --------------------