Group settings by sub-category

alphagov · Jun 1, 2018 · 307c86a · 307c86a
1 parent 8e23904
commit 307c86a
Show file tree

Hide file tree

Showing 9 changed files with 17 additions and 11 deletions.
diff --git a/src/settings/_assets.scss b/src/settings/_assets.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/assets
 ////
 
 /// Path to the assets directory, with trailing slash.

diff --git a/src/settings/_colours-applied.scss b/src/settings/_colours-applied.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/colours
 ////
 
 

diff --git a/src/settings/_compatibility.scss b/src/settings/_compatibility.scss
@@ -5,7 +5,7 @@
 /// We default these settings to `true` so that if they are missed we opt for a
 /// mild performance hit over a potential broken experience for the end-user.
 ///
-/// @group settings
+/// @group settings/compatibility
 ////
 
 

diff --git a/src/settings/_global-styles.scss b/src/settings/_global-styles.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/global-styles
 ////
 
 /// Include 'global' styles

diff --git a/src/settings/_ie8.scss b/src/settings/_ie8.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/ie8
 ////
 
 /// Whether the stylesheet being built is targeting Internet Explorer 8.

diff --git a/src/settings/_measurements.scss b/src/settings/_measurements.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/measurements
 ////
 
 

diff --git a/src/settings/_typography-font-families.scss b/src/settings/_typography-font-families.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/typography
 ////
 
 /// List of font families to use if using NTA (the default font 'stack' for

diff --git a/src/settings/_typography-font.scss b/src/settings/_typography-font.scss
@@ -1,5 +1,5 @@
 ////
-/// @group settings
+/// @group settings/typography
 ////
 
 

diff --git a/tasks/gulp/sassdoc.js b/tasks/gulp/sassdoc.js
@@ -1,15 +1,21 @@
 const sassdoc = require('sassdoc')
 const gulp = require('gulp')
 const paths = require('../../config/paths.json')
-const debug = require('gulp-debug')
 
 gulp.task('sassdoc', function () {
   return gulp.src([paths.src + '**/**/*.scss', `!${paths.src}/vendor/*`])
-    .pipe(debug())
     .pipe(sassdoc({
       dest: paths.sassdoc,
       groups: {
-        settings: 'Settings',
+        'settings/assets': 'Settings / Assets',
+        'settings/colours': 'Settings / Colours',
+        'settings/compatibility': 'Settings / Compatibility',
+        'settings/global-styles': 'Settings / Global Styles',
+        'settings/ie8': 'Settings / IE8',
+        'settings/measurements': 'Settings / Measurements',
+        'settings/media-queries': 'Settings / Media Queries',
+        'settings/spacing': 'Settings / Spacing',
+        'settings/typography': 'Settings / Typography',
         tools: 'Tools',
         helpers: 'Helpers',
         overrides: 'Overrides'