Fix: whatsnew config instructions (#619)

Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
ansys · Feb 6, 2025 · 8e13e2f · 8e13e2f
1 parent ff4d6f6
commit 8e13e2f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/changelog.d/619.documentation.md b/doc/changelog.d/619.documentation.md
@@ -0,0 +1 @@
+Fix: whatsnew config instructions
diff --git a/doc/source/user-guide/options.rst b/doc/source/user-guide/options.rst
@@ -269,7 +269,7 @@ To install the "What's new" dependencies from ansys-sphinx-theme, run the follow
 
     pip install ansys-sphinx-theme[changelog]
 
-To get started, create a YAML file named ``whatsnew.yml`` in the ``doc/source`` directory. The
+To get started, create a YAML file named ``whatsnew.yml`` in the ``doc/changelog.d`` directory. The
 YAML file should contain the following structure:
 
 .. code-block:: yaml
@@ -315,7 +315,7 @@ to the ``html_theme_options`` dictionary:
     html_theme_options = (
         {
             "whatsnew": {
-                "whatsnew_file_path": "changelog.d/whatsnew.yml",
+                "whatsnew_file_path": "../changelog.d/whatsnew.yml",
                 "changelog_file_path": "changelog.rst",
                 "sidebar_pages": ["changelog"],
                 "sidebar_no_of_headers": 3,  # Optional