feat: add customization instructions for SCSS files in developer documentation

.github/labeler.yml

@@ -8,7 +8,7 @@
 
 # -- Documentation labels ----------------------------------------------------
 
-'documentation':
+'docs':
   - all:
       - changed-files:
           - any-glob-to-any-file: ['doc/source/**/*.rst', 'README.rst']

.github/labels.yml

@@ -87,25 +87,25 @@
 
 # -- HTML, CSS, JS, and web development labels -------------------------------
 
-- name: css
+- name: 'css'
   description: Requires or modifies cascading style sheets
   color: d4c5f9
 
-- name: js
+- name: 'js'
   description: Requires or modifies JavaScript code
   color: fef2c0
 
-- name: ui/ux
+- name: 'ui/ux'
   description: Related with UI/UX design
   color: ffffff
 
 # -- Hacktoberfest labels ----------------------------------------------------
 
-- name: hacktoberfest
+- name: 'hacktoberfest'
   description: Hacktoberfest related
   color: 62ca50
 
-- name: hacktoberfest-accepted
+- name: 'hacktoberfest-accepted'
   description: Hacktoberfest accepted contribution
   color: 62ca50
 

.github/workflows/ci_cd.yml

@@ -26,17 +26,19 @@ jobs:
       pull-requests: write
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
-      - uses: actions/checkout@v4
-      - uses: micnncim/action-label-syncer@v1
+      - name: "Update labels"
+        uses: micnncim/action-label-syncer@3abd5ab72fda571e69fffd97bd4e0033dd5f495c # v1.3.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: "Label pull-request"
-        uses: actions/[email protected]
+        uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
 
+
   changelog-fragment:
     name: "Create changelog fragment"
     needs: [labeler]

doc/changelog.d/694.added.md

@@ -0,0 +1 @@
+add customization instructions for SCSS files in developer documentation

doc/source/contribute/developer.rst

@@ -211,6 +211,52 @@ This way, it's not possible for you to push code that fails the style checks::
   Add License Headers......................................................Passed
 
 
+Customize the theme
+-------------------
+Theme configuration is distributed across multiple files for flexibility and modularity.
+
+
+Customize the SCSS files
+************************
+
+Many styles are defined in SCSS files located in the ``src/ansys_sphinx_theme/assets/styles/`` directory.
+The primary SCSS files include:
+
+- ``ansys-sphinx-theme.scss``: Contains the main theme configuration.
+- ``pydata-sphinx-theme-custom.scss``: Contains custom modifications for the PyData theme.
+
+To modify the SCSS files, follow these steps:
+
+1. Navigate to the ``src/ansys_sphinx_theme/assets/styles/`` directory.
+2. Edit the relevant SCSS files as needed.
+3. Build the SCSS files using the following command:
+
+   .. code-block:: bash
+
+      python -m pip install -e '.[doc]'
+      stb serve doc/source
+
+   After the build completes, the documentation is served on ``localhost`` and automatically opens
+   in the default web browser. SCSS file changes are monitored, and the documentation rebuilds automatically.
+
+.. note::
+
+   To use **Tox** for building and serving documentation, run the following command:
+
+   .. code-block:: bash
+
+      python -m tox -e doc-serve
+
+   This command builds the documentation, opens it in the default browser, and monitors the source files for changes to
+   trigger automatic rebuilds.
+
+.. important::
+
+   The built SCSS files are stored in the
+   ``src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/styles/`` directory.
+   These files are regenerated during each build process, so avoid editing them directly.
+
+
 Build the documentation
 -----------------------