Use explicit documentation paths for modules that are nested into subdirectories

Signed-off-by: Chris Cummer <chriscummer@me.com>

modules/cds/favorites/settings.go

@@ -32,5 +32,8 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		apiURL:   ymlConfig.UString("apiURL", os.Getenv("CDS_API_URL")),
 		hideTags: utils.ToStrs(ymlConfig.UList("hideTags")),
 	}
+
+	settings.SetDocumentationPath("cds/favorites")
+
 	return &settings
 }

modules/cds/queue/settings.go

@@ -29,5 +29,8 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		token:  ymlConfig.UString("token", ymlConfig.UString("token", os.Getenv("CDS_TOKEN"))),
 		apiURL: ymlConfig.UString("apiURL", os.Getenv("CDS_API_URL")),
 	}
+
+	settings.SetDocumentationPath("cds/queue")
+
 	return &settings
 }

modules/cds/status/settings.go

@@ -14,7 +14,8 @@ const (
 
 // Settings defines the configuration properties for this module
 type Settings struct {
-	common *cfg.Common
+	*cfg.Common
+
 	token  string `help:"Your CDS API token."`
 	apiURL string `help:"Your CDS API URL."`
 	uiURL  string
@@ -23,9 +24,13 @@ type Settings struct {
 // NewSettingsFromYAML creates a new settings instance from a YAML config block
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
 	settings := Settings{
-		common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+
 		token:  ymlConfig.UString("token", ymlConfig.UString("token", os.Getenv("CDS_TOKEN"))),
 		apiURL: ymlConfig.UString("apiURL", os.Getenv("CDS_API_URL")),
 	}
+
+	settings.SetDocumentationPath("cds/status")
+
 	return &settings
 }

modules/cds/status/widget.go

@@ -29,8 +29,8 @@ type Widget struct {
 // NewWidget creates a new instance of the widget
 func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget {
 	widget := Widget{
-		MultiSourceWidget: view.NewMultiSourceWidget(settings.common, "workflow", "workflows"),
-		TextWidget:        view.NewTextWidget(app, pages, settings.common),
+		MultiSourceWidget: view.NewMultiSourceWidget(settings.Common, "workflow", "workflows"),
+		TextWidget:        view.NewTextWidget(app, pages, settings.Common),
 
 		settings: settings,
 	}

modules/cryptoexchanges/bittrex/settings.go

@@ -63,5 +63,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		settings.summary.currencies[key] = currency
 	}
 
+	settings.SetDocumentationPath("cryptocurrencies/bittrex")
+
 	return &settings
 }

modules/cryptoexchanges/blockfolio/settings.go

@@ -34,5 +34,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		displayHoldings: ymlConfig.UBool("displayHoldings", true),
 	}
 
+	settings.SetDocumentationPath("cryptocurrencies/blockfolio")
+
 	return &settings
 }

modules/cryptoexchanges/cryptolive/settings.go

@@ -73,5 +73,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 	settings.colors.top.to.field = ymlConfig.UString("colors.top.to.field")
 	settings.colors.top.to.value = ymlConfig.UString("colors.top.to.value")
 
+	settings.SetDocumentationPath("cryptocurrencies/cryptolive")
+
 	return &settings
 }

modules/football/settings.go

@@ -38,5 +38,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 
 	cfg.ModuleSecret(name, globalConfig, &settings.apiKey).Load()
 
+	settings.SetDocumentationPath("sports/football")
+
 	return &settings
 }

modules/gcal/settings.go

@@ -78,5 +78,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 	settings.colors.past = ymlConfig.UString("colors.past", "gray")
 	settings.colors.title = ymlConfig.UString("colors.title", "white")
 
+	settings.SetDocumentationPath("google/gcal")
+
 	return &settings
 }

modules/googleanalytics/settings.go

@@ -30,5 +30,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		enableRealtime: ymlConfig.UBool("enableRealtime", false),
 	}
 
+	settings.SetDocumentationPath("google/analytics")
+
 	return &settings
 }

modules/gspreadsheets/settings.go

@@ -36,5 +36,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 
 	settings.colors.values = ymlConfig.UString("colors.values", "green")
 
+	settings.SetDocumentationPath("google/spreadsheet")
+
 	return &settings
 }

modules/ipaddresses/ipapi/settings.go

@@ -29,5 +29,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 	settings.colors.name = ymlConfig.UString("colors.name", "red")
 	settings.colors.value = ymlConfig.UString("colors.value", "white")
 
+	settings.SetDocumentationPath("ipaddress/ipapi")
+
 	return &settings
 }

modules/ipaddresses/ipinfo/settings.go

@@ -19,5 +19,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
 	}
 
+	settings.SetDocumentationPath("ipaddress/ipinfo")
+
 	return &settings
 }

modules/nbascore/settings.go

@@ -19,5 +19,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
 	}
 
+	settings.SetDocumentationPath("sports/nbascore")
+
 	return &settings
 }

modules/twitter/settings.go

@@ -33,5 +33,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		screenNames:    ymlConfig.UList("screenName"),
 	}
 
+	settings.SetDocumentationPath("twitter/tweets")
+
 	return &settings
 }

modules/twitterstats/settings.go

@@ -32,5 +32,7 @@ func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *co
 		screenNames: ymlConfig.UList("screenNames"),
 	}
 
+	settings.SetDocumentationPath("twitter/stats")
+
 	return &settings
 }