Skip to content

Commit eddbf8c

Browse files
refactor: cheatsheet and whatsnew functions into separate modules and implement sidebar ordering (#656)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 5055fec commit eddbf8c

File tree

6 files changed

+836
-717
lines changed

6 files changed

+836
-717
lines changed

doc/changelog.d/656.miscellaneous.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
cheatsheet and whatsnew functions into separate modules and implement sidebar ordering

doc/source/user-guide/options.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@ main ``index.rst`` file and the ``learning.rst`` file in its "Getting started" s
257257
the theme is using `pdf2image`. So you should have the ``poppler`` package installed in your system.
258258
For more information, see the `pdf2image documentation <https://pypi.org/project/pdf2image/>`_.
259259

260+
260261
What's new section
261262
------------------
262263

@@ -350,3 +351,10 @@ The following images show a sample "What's new" section and sidebar in the chang
350351

351352
.. image:: ../_static/whatsnew_sidebar.png
352353
:alt: What's new sidebar
354+
355+
356+
.. note::
357+
358+
If you are using both the "whatsnew" and "cheatsheet" options, the "cheatsheet" option will be
359+
displayed first in the left navigation pane, followed by the "What's new" section to maintain
360+
sidebar consistency.

doc/styles/config/vocabularies/ANSYS/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ Sewell
2424
(?i)Sphinx-Gallery
2525
(?i)favicon
2626
astroid
27+
(?i)whatsnew

0 commit comments

Comments
 (0)