docs: reformat the userguide and logos

Author: Revathyvenugopal162

doc/source/getting_started/index.rst

@@ -5,7 +5,7 @@ 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.
-If you are interested in contributing to the theme, see the `Contributing <Pyansys_contributing>` for
+If you are interested in contributing to the theme, see the `PyAnsys Contributing <Pyansys_contributing>`_ for
 information on installing the theme in development mode.
 
 Package dependencies

doc/source/user_guide/index.rst

@@ -1,13 +1,63 @@
 .. _ref_user_guide:
 
-==========
 User guide
-==========
-The Ansys Sphinx theme is based on the `PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_.
-For more information on its configuration, see
-`Configuration <https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/>`_.
+##########
+
+This section provides information on how to customize the Ansys Sphinx theme.
+
+Basic usage
+===========
+Add the following to your `conf.py` file to use the Ansys Sphinx theme:
+
+.. code-block:: python
+
+   html_theme = "ansys_sphinx_theme"
+
+From ansys sphinx theme you can use the following features:
+
+#. **PyAnsys and Ansys logos**
+
+   The Ansys Sphinx theme includes the PyAnsys and Ansys logos. All The logos
+   are available in the
+   `ansys_sphinx_theme/static/ <https://github.com/ansys/ansys-sphinx-theme/blob/main/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/logos>`_
+   directory. You can use the following code to add the logos to your documentation:
+
+   .. code-block:: python
+
+      from ansys_sphinx_theme import pyansys_logo_black, ansys_logo_black, ansys_favicon
+
+      html_logo = pyansys_logo_black
+      html_favicon = ansys_favicon
+
+   ``favicon`` is the icon that appears in the browser tab.
+
+#. **Version switcher**
+
+   The Ansys Sphinx theme includes a version switcher that allows users to switch between different versions of the documentation.
+   To use the version switcher, add the following code to your `conf.py` file:
+
+   .. code::
+
+      from ansys_sphinx_theme import get_version_match
+
+      version = "<your_version>"
+      switcher_versions = get_version_match(version)
+      cname = "<your_cname>"
+      html_theme_options = {
+      "switcher": {
+        "json_url": f"https://{cname}/versions.json",
+        "version_match": switcher_version,
+    },
+
+   The switcher requires a `versions.json` file that contains the versions of the documentation and their URLs in the given ``json_url``.
+   see `PyAnsys multi-version documentation <https://dev.docs.pyansys.com/how-to/documenting.html#enable-multi-version-documentation>`_
+   for more information.
+
+#. PDF cover page
+
+   The Ansys Sphinx theme includes a PDF cover page that you can customize.
+   To customize the PDF cover page, see :ref:`ref_user_guide_pdf_cover`.
 
-While the Ansys Sphinx theme is often used as is, you can customize the following:
 
 .. grid:: 1 1 2 2
    :gutter: 2

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

@@ -11,6 +11,7 @@ link_code_branch
 html_context
 autoapi
 (?i)HTML
+multi-version
 CSS
 PDF
 namespaces

src/ansys_sphinx_theme/__init__.py

@@ -52,16 +52,17 @@
 TEMPLATES_PATH = THEME_PATH / "_templates"
 AUTOAPI_TEMPLATES_PATH = TEMPLATES_PATH / "autoapi"
 JS_FILE = JS_PATH / "table.js"
+LOGOS_PATH = STATIC_PATH / "logos"
 
 # make logo paths available
-ansys_favicon = str((STATIC_PATH / "ansys-favicon.png").absolute())
-ansys_logo_black = str((STATIC_PATH / "ansys_logo_black_cropped.jpg").absolute())
-ansys_logo_white = str((STATIC_PATH / "ansys_logo_white.pdf").absolute())
-ansys_logo_white_cropped = str((STATIC_PATH / "ansys_logo_white_cropped.pdf").absolute())
+ansys_favicon = str((LOGOS_PATH / "ansys-favicon.png").absolute())
+ansys_logo_black = str((LOGOS_PATH / "ansys_logo_black_cropped.jpg").absolute())
+ansys_logo_white = str((LOGOS_PATH / "ansys_logo_white.pdf").absolute())
+ansys_logo_white_cropped = str((LOGOS_PATH / "ansys_logo_white_cropped.pdf").absolute())
 page_404 = str((STATIC_PATH / "404.rst").absolute())
-pyansys_logo_black = str((STATIC_PATH / "pyansys-logo-black-cropped.png").absolute())
-pyansys_logo_white = str((STATIC_PATH / "pyansys-logo-white-cropped.png").absolute())
-watermark = str((STATIC_PATH / "watermark.pdf").absolute())
+pyansys_logo_black = str((LOGOS_PATH / "pyansys-logo-black-cropped.png").absolute())
+pyansys_logo_white = str((LOGOS_PATH / "pyansys-logo-white-cropped.png").absolute())
+watermark = str((LOGOS_PATH / "watermark.pdf").absolute())
 
 
 def get_html_theme_path() -> pathlib.Path: