ver: bump version 0.15.1

Author: Revathyvenugopal162

doc/source/getting_started/index.rst

@@ -3,13 +3,37 @@
 ===============
 Getting started
 ===============
-`Sphinx <https://www.sphinx-doc.org/en/master/>`_ is a Python documentation
+`Sphinx <Sphinx_>`_ is a Python documentation
 generator for creating documentation. If you are new to using Sphinx, see
-`Sphinx Getting Started <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.
+`Sphinx Getting Started <Sphinx_Getting_Started_>`_.
 
 This section explains how to install the Ansys Sphinx theme and then set up your
 Sphinx ``conf.py`` file to use this theme to generate your documentation.
 
+Dependencies
+------------
+
+Ansys sphinx theme build on top of ``pydata sphinx theme``. 
+The theme requires the following dependencies:
+
+- `Sphinx <Sphinx_PyPI_>`_
+- `pydata-sphinx-theme <PyData_PyPI_>`_
+- `Jinja2 <Jinja2_PyPI_>`_
+
+Optional dependencies
+---------------------
+
+Ansys Sphinx theme includes optional dependencies for autoapi documentation. 
+To utilize `sphinx-autoapi` with custom templates provided by the theme, 
+you need to install the following dependencies:
+
+- `sphinx-autoapi <Sphinx_AutoAPI_PyPI_>`_
+- `sphinx-design <Sphinx_Design_PyPI_>`_
+
+An example page demonstrating autoapi rendering with the Ansys sphinx theme template can
+be found found on the ``API Reference`` page of the 
+`PyAnsys Geometry documentation <PyAnsys_Geometry_Docs_>`_.
+
 Install the theme
 -----------------
 Install the Ansys Sphinx theme with:
@@ -18,6 +42,12 @@ Install the Ansys Sphinx theme with:
 
    pip install ansys-sphinx-theme
 
+For installing the optional dependencies, use:
+
+.. code::
+
+   pip install ansys-sphinx-theme[autoapi]
+
 Modify the ``conf.py`` file
 ---------------------------
 To use this theme, modify your Sphinx ``conf.py`` file::
@@ -33,3 +63,14 @@ Consider using the ``conf.py`` for this repository:
 .. toctree::
    :hidden:
    :maxdepth: 2
+
+.. LINKS and References 
+
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
+.. _Sphinx_Getting_Started: https://www.sphinx-doc.org/en/master/usage/quickstart.html
+.. _Sphinx_PyPI: https://pypi.org/project/Sphinx/
+.. _PyData_PyPI: https://pypi.org/project/pydata-sphinx-theme/
+.. _Jinja2_PyPI: https://pypi.org/project/Jinja2/
+.. _Sphinx_AutoAPI_PyPI: https://pypi.org/project/sphinx-autoapi/
+.. _Sphinx_Design_PyPI: https://pypi.org/project/sphinx-design/
+.. _PyAnsys_Geometry_Docs: https://geometry.docs.pyansys.com/

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 # Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
 name = "ansys-sphinx-theme"
-version = "0.15.0"
+version = "0.15.1"
 description = "A theme devised by ANSYS, Inc. for Sphinx documentation."
 readme = "README.rst"
 requires-python = ">=3.9,<4"
@@ -32,6 +32,10 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
+autoapi = [
+    "sphinx-autoapi==3.0.0a4",
+    "sphinx-design==0.5.0",
+]
 doc = [
     "numpydoc==1.7.0",
     "Sphinx==7.2.6",