docs: add admonitions to the example page

Author: Revathyvenugopal162

doc/source/conf.py

@@ -77,6 +77,7 @@
     "sphinx_design",
     "sphinx_jinja",
     "sphinx_gallery.gen_gallery",
+    "sphinx.ext.todo",
 ]
 
 # Intersphinx mapping
@@ -180,7 +181,7 @@
 
 
 def extract_example_links(
-    repo_fullname: str, path_relative_to_root: str, exclude_files: List[str]
+    repo_fullname: str, path_relative_to_root: str, exclude_files: List[str] = []
 ) -> List[str]:
     """
     Extract example links from a specific GitHub repository.
@@ -202,7 +203,8 @@ def extract_example_links(
     g = Github()
     repo = g.get_repo(repo_fullname)
     contents = repo.get_contents(path_relative_to_root)
-
+    if not isinstance(contents, list):
+        contents = [contents]
     example_links = []
     for content in contents:
         if content.type == "dir":
@@ -252,8 +254,17 @@ def download_and_process_files(example_links: List[str]) -> List[str]:
 )
 file_names = download_and_process_files(example_links)
 
+admonitions_links = extract_example_links(
+    "pydata/pydata-sphinx-theme",
+    "docs/examples/kitchen-sink/admonitions.rst",
+)
+
+admonitions_links = download_and_process_files(admonitions_links)
+print(admonitions_links)
+
 jinja_contexts = {
     "examples": {"inputs_examples": file_names},
+    "admonitions": {"inputs_admonitions": admonitions_links},
     "install_guide": {
         "version": f"v{version}" if not version.endswith("dev0") else "main",
     },

doc/source/examples.rst

@@ -28,11 +28,18 @@ extensions are rendered in the theme.
 
          Examples of sphinx gallery rendered using the `ansys-sphinx-theme`.
 
+   .. grid-item-card:: Admonitions
+         :link: admonitions
+         :link-type: ref
+
+         Examples of admonitions rendered using the `ansys-sphinx-theme`.
+
 
 .. toctree::
    :hidden:
    :maxdepth: 2
 
    examples/sphinx-design
    examples/table
+   examples/admonitions
 

doc/source/examples/admonitions.rst

@@ -0,0 +1,23 @@
+.. _admonitions:
+
+Admonitions
+===========
+
+Admonitions are a way to highlight important information in your documentation. They are a way to draw attention to important information,
+and can be used to provide additional context or information to the reader.
+
+This page shows how the admonitions are rendered in the documentation with ansys sphinx theme.
+
+Credits and acknowledgments
+---------------------------
+The examples shown below is downloaded from the pydata sphinx theme project.
+The original page can be found at `Pydata sphinx theme <https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/index.html>`_ .
+
+
+.. jinja:: admonitions
+
+    {% for filename in inputs_admonitions %}
+
+    .. include:: sphinx_examples/{{ filename }}
+
+    {% endfor %}