Setup Sphinx build and layout

alhendrickson · alhendrickson · commit 4b68ea397b36 · 2025-06-03T12:37:17.000Z
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/conf.py b/docs/conf.py
@@ -2,14 +2,19 @@
 #
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+sys.path.insert(0, os.path.abspath("../observability/docs"))
 
+print("Hello")
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'Observability'
+project = 'CogStack Platform Toolkit'
 copyright = '2025, CogStack Org'
 author = 'CogStack Org'
 release = 'latest'
+html_title = "CogStack Platform Toolkit"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -28,5 +33,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "furo"
 html_static_path = ['_static']
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+   
+# Cogstack Platform Toolit
+
+This project provides utilities for running Cogstack in production
+
+## Features
+
+- [Observability](observability/_index.md) 
+
+```{toctree}
+:hidden:
+
+observability/_index
+
+```
+
+
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/observability/_index.md b/docs/observability/_index.md
@@ -1,5 +1,4 @@
-   
-# Cogstack Observability Stack
+# Cogstack Observability
 
 This project provides observability of a cogstack deployment.
 
@@ -10,19 +9,13 @@ It provides the following features:
 - Blackbox Probing of services to find service level indicators of uptime and latency
 - A working inventory of what is running where
 
-## Contents
 
 See the [Quickstart](./get-started/quickstart.md) to see how to easily run this stack.
 
-
 ```{toctree}
 :maxdepth: 2
-get-started/quickstart.md
-get-started/userguide-tutorial.md
-```
 
-## Indices and tables
+get-started/_index
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+
+```
diff --git a/docs/observability/get-started/_index.md b/docs/observability/get-started/_index.md
@@ -0,0 +1,8 @@
+# Getting Started
+
+```{toctree}
+:maxdepth: 2
+quickstart
+setup-tutorial
+userguide-tutorial
+```
diff --git a/docs/observability/get-started/quickstart-manual.md b/docs/observability/get-started/quickstart-manual.md
@@ -1,5 +1,4 @@
-
-## Manual Quickstart
+# Manual Quickstart
 
 The quickstart page uses a script to setup the folders for you.
 
@@ -11,7 +10,8 @@ Create the necessary directory structure
 mkdir -p observability-simple/prometheus/scrape-configs/probers
 mkdir -p observability-simple/prometheus/scrape-configs/exporters
 ```
-
+ Something
+ 
 
 Download these two files from github, and place in the right folder
 
diff --git a/docs/observability/get-started/quickstart.md b/docs/observability/get-started/quickstart.md
diff --git a/docs/observability/get-started/setup-tutorial.md b/docs/observability/get-started/setup-tutorial.md
@@ -1,7 +1,5 @@
-
-This page 
-
-
+# Production Setup
+This page shows how to setup the stack for production
 
 ## Run the Observability Stack using Docker Compose
 
diff --git a/docs/observability/get-started/userguide-tutorial.md b/docs/observability/get-started/userguide-tutorial.md
@@ -0,0 +1,3 @@
+# Dashboard User Guide
+
+This is my dashboard user guide
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,6 @@
 Sphinx==6.2.1
 sphinx-rtd-theme~=1.0
 myst-parser~=0.17
-sphinx-autoapi==3.0.0
+sphinx-autoapi==3.0.0
+sphinx-autobuild
+furo
diff --git a/observability/docs/get-started/userguide-tutorial.md b/observability/docs/get-started/userguide-tutorial.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Dashboard User Guide`
	`2`	`+`
	`3`	`+This is my dashboard user guide`