Skip to content

Commit 3999092

Browse files
klmcadamspyansys-ci-bot
authored andcommitted
Fix: whatsnew config instructions (#619)
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
1 parent ef16f64 commit 3999092

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

doc/changelog.d/619.documentation.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix: whatsnew config instructions

doc/source/user-guide/options.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ To install the "What's new" dependencies from ansys-sphinx-theme, run the follow
269269
270270
pip install ansys-sphinx-theme[changelog]
271271
272-
To get started, create a YAML file named ``whatsnew.yml`` in the ``doc/source`` directory. The
272+
To get started, create a YAML file named ``whatsnew.yml`` in the ``doc/changelog.d`` directory. The
273273
YAML file should contain the following structure:
274274

275275
.. code-block:: yaml
@@ -315,7 +315,7 @@ to the ``html_theme_options`` dictionary:
315315
html_theme_options = (
316316
{
317317
"whatsnew": {
318-
"whatsnew_file_path": "changelog.d/whatsnew.yml",
318+
"whatsnew_file_path": "../changelog.d/whatsnew.yml",
319319
"changelog_file_path": "changelog.rst",
320320
"sidebar_pages": ["changelog"],
321321
"sidebar_no_of_headers": 3, # Optional

0 commit comments

Comments
 (0)