docs: adding title in example section (#524)

Co-authored-by: pyansys-ci-bot <[email protected]>
ansys · Oct 3, 2024 · 279a027 · 279a027
1 parent 4d25de6
commit 279a027
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/doc/changelog.d/524.documentation.md b/doc/changelog.d/524.documentation.md
@@ -0,0 +1 @@
+docs: adding ``title`` in example section
diff --git a/doc/source/user-guide/options.rst b/doc/source/user-guide/options.rst
@@ -179,6 +179,7 @@ Here is an example of how to add the ``cheatsheet`` dictionary to the `html_them
         {
             "cheatsheet": {
                 "file": "<file name including the extension of the cheat sheet>",
+                "title": "<title of the cheat sheet>",
                 "version": "<version of the cheat sheet>",
                 "pages": "<list of names for the pages to include the cheat sheet on>",  # Optional
             },
@@ -194,6 +195,7 @@ main ``index.rst`` file and the ``learning.rst`` file in its "Getting started" s
         {
             "cheatsheet": {
                 "file": "getting_started/cheat_sheet.qmd",
+                "title": "My awesome cheat sheet",
                 "version": f"{version}",
                 "pages": ["index", "getting_started/learning"],
             },