feat: adapt package to general PyAnsys repository layout (#387)

Revathyvenugopal162 · pyansys-ci-bot · RobPasMue · Revathyvenugopal162 · commit ae362bb50612 · 2024-05-29T17:24:20.000+02:00
Co-authored-by: pyansys-ci-bot &lt;pyansys.github.bot@ansys.com&gt;
Co-authored-by: Roberto Pastor Muela &lt;37798125+RobPasMue@users.noreply.github.com&gt;
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -95,7 +95,7 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python-version: ['3.9', '3.10', '3.11', '3.12']
-        should-release: 
+        should-release:
           - ${{ github.event_name == 'push' && contains(github.ref, 'refs/tags') }}
         exclude:
           - should-release: false
diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -41,7 +41,7 @@ jobs:
     # Label based on branch name
     - uses: actions-ecosystem/action-add-labels@v1
       if: |
-        startsWith(github.event.pull_request.head.ref, 'doc') || 
+        startsWith(github.event.pull_request.head.ref, 'doc') ||
         startsWith(github.event.pull_request.head.ref, 'docs')
       with:
         labels: documentation
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/psf/black
-  rev: 24.2.0
+  rev: 24.4.2
   hooks:
   - id: black
 
@@ -32,15 +32,16 @@ repos:
     types_or: [css, javascript]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.5.0
+  rev: v4.6.0
   hooks:
   - id: check-merge-conflict
   - id: debug-statements
-  - id: requirements-txt-fixer
+  - id: check-yaml
+  - id: trailing-whitespace
 
 # this validates our github workflow files
 - repo: https://github.com/python-jsonschema/check-jsonschema
-  rev: 0.28.0
+  rev: 0.28.4
   hooks:
     - id: check-github-workflows
 
@@ -49,11 +50,11 @@ repos:
   rev: 1.16.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.7.0]
+    additional_dependencies: [black==24.4.2]
     exclude: 'src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/'
 
 - repo: https://github.com/ansys/pre-commit-hooks
-  rev: v0.2.9
+  rev: v0.3.1
   hooks:
   - id: add-license-headers
     args:
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1,12 @@
+# This is the list of ansys-sphinx-theme's significant contributors.
+#
+# This file does not necessarily list everyone who has contributed code.
+#
+# For contributions made under a Corporate CLA, the organization is
+# added to this file.
+#
+# If you have contributed to the repository and want to be added to this file,
+# submit a request.
+#
+#
+ANSYS, Inc.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,20 @@
+# Contributors
+
+## Project Lead
+* [Revathy Venugopal](https://github.com/Revathyvenugopal162)
+
+## Individual Contributors
+
+* [Alexander Kaszynski](https://github.com/akaszynski)
+* [Andy Grigg](https://github.com/Andy-Grigg)
+* [Dipin Nair](https://github.com/dipinknair)
+* [Dominik Gresch](https://github.com/greschd)
+* [German Martínez](https://github.com/germa89)
+* [Guillem Barroso](https://github.com/GuillemBarroso)
+* [Jess Leonatti](https://github.com/jleonatti)
+* [Jorge Martínez](https://github.com/jorgepiloto)
+* [Kathy Pipet](https://github.com/PipKat)
+* [Kerry McAdams](https://github.com/klmcadams)
+* [Maxime Rey](https://github.com/MaxJPRey)
+* [Paul Profizi](https://github.com/PProfizi)
+* [Roberto Pastor](https://github.com/RobPasMue)
diff --git a/LICENSE b/LICENSE
@@ -1,13 +1,13 @@
 MIT License
 
-Copyright (c) 2022-2024 ANSYS, Inc. and/or its affiliates.
+Copyright (c) 2021 - 2024 ANSYS, Inc. and/or its affiliates.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
diff --git a/README.rst b/README.rst
@@ -34,7 +34,7 @@ Ansys Sphinx theme
 Introduction
 ------------
 The Ansys Sphinx theme is an extension of the popular
-`PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_ 
+`PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_
 that is used by `numpy <https://numpy.org/doc/stable/>`_,
 `pandas <https://pandas.pydata.org/docs/>`_,
 `pyvista <https://docs.pyvista.org>`_, and many more
@@ -92,10 +92,10 @@ You can optionally install and use this tool. For more information, see its
 <https://pre-commit.com/#usage>`_ documentation.
 
 Before contributing to a PyAnsys library, see
-`Contributing <https://dev.docs.pyansys.com//how-to/contributing.html>`_ 
+`Contributing <https://dev.docs.pyansys.com//how-to/contributing.html>`_
 in the *PyAnsys Developer's Guide* for overall guidance, paying particular
-attention to `How-to <https://dev.docs.pyansys.com//how-to/index.html>`_ for 
-guidelines and best practices. 
+attention to `How-to <https://dev.docs.pyansys.com//how-to/index.html>`_ for
+guidelines and best practices.
 
 License
 ~~~~~~~
diff --git a/doc/Makefile b/doc/Makefile
@@ -17,7 +17,7 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	
+
 # customized clean due to api examples
 clean:
 	rm -rf $(BUILDDIR)
diff --git a/doc/changelog.d/387.added.md b/doc/changelog.d/387.added.md
@@ -0,0 +1 @@
+feat: adapt package to general PyAnsys repository layout
diff --git a/doc/make.bat b/doc/make.bat
@@ -37,6 +37,6 @@ goto end
 	cd "%BUILDDIR%\latex"
 	for %%f in (*.tex) do (
 	pdflatex "%%f" --interaction=nonstopmode)
-	
+
 :end
 popd
diff --git a/doc/source/examples/sphinx-design.rst b/doc/source/examples/sphinx-design.rst
@@ -16,7 +16,7 @@ please refer `sphinx design <https://sphinx-design.readthedocs.io/en/latest/inde
 
     .. literalinclude:: sphinx_examples/{{ filename }}
        :language: rst
-        
+
     This directive renders as follows:
 
     .. include:: sphinx_examples/{{ filename }}
diff --git a/doc/source/examples/table.rst b/doc/source/examples/table.rst
@@ -3,7 +3,7 @@
 Table
 =====
 The table directive with ansys sphinx theme allows for rendering of tables.
-There are different types of tables, such as the data table, longtable-centered, 
+There are different types of tables, such as the data table, longtable-centered,
 and table-centered, each serving different purposes.
 
 Normal table
@@ -75,7 +75,7 @@ Here is an example of a longtable-centered:
 
 .. code:: rst
 
-    .. table:: 
+    .. table::
         :class: longtable-centered
 
         +---------------------------+-------------------+
@@ -88,7 +88,7 @@ Here is an example of a longtable-centered:
         | **GUI commands**          | * ``*ASK``        |
         +---------------------------+-------------------+
 
-.. table:: 
+.. table::
    :class: longtable-centered
 
    +---------------------------+-------------------+
@@ -109,7 +109,7 @@ Here is an example of a table-centered:
 
 .. code:: rst
 
-    .. table:: 
+    .. table::
         :class: table-centered
 
         +---------------------------+-------------------+
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -13,7 +13,7 @@ Sphinx ``conf.py`` file to use this theme to generate your documentation.
 Dependencies
 ------------
 
-Ansys sphinx theme build on top of ``pydata sphinx theme``. 
+Ansys sphinx theme build on top of ``pydata sphinx theme``.
 The theme requires the following dependencies:
 
 - `Sphinx <Sphinx_PyPI_>`_
@@ -23,16 +23,16 @@ The theme requires the following dependencies:
 Optional dependencies
 ---------------------
 
-Ansys Sphinx theme includes optional dependencies for autoapi documentation. 
-To utilize `sphinx-autoapi` with custom templates provided by the theme, 
+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_>`_
 - `sphinx-jinja <Sphinx_Jinja_PyPI_>`_
 
 An example page demonstrating autoapi rendering with the Ansys sphinx theme template can
-be found on the ``API Reference`` page of the 
+be found on the ``API Reference`` page of the
 `PyAnsys Geometry documentation <PyAnsys_Geometry_Docs_>`_.
 
 Install the theme
@@ -65,7 +65,7 @@ Consider using the ``conf.py`` for this repository:
    :hidden:
    :maxdepth: 2
 
-.. LINKS and References 
+.. LINKS and References
 
 .. _Sphinx: https://www.sphinx-doc.org/en/master/
 .. _Sphinx_Getting_Started: https://www.sphinx-doc.org/en/master/usage/quickstart.html
diff --git a/doc/source/user_guide/404_page.rst b/doc/source/user_guide/404_page.rst
@@ -8,7 +8,7 @@ Because Sphinx does not create a 404 page by default, you can use the
 <https://sphinx-notfound-page.readthedocs.io/en/latest/index.html>`_ extension
 for 404 pages. While originally developed to be used with `Read the Docs <https://readthedocs.org/>`_,
 this extension can be used in other hosting services. For more
-information, see the extension's `documentation <https://sphinx-notfound-page.readthedocs.io/en/latest/how-it-works.html>`_. 
+information, see the extension's `documentation <https://sphinx-notfound-page.readthedocs.io/en/latest/how-it-works.html>`_.
 
 Install the extension
 ---------------------
@@ -66,18 +66,18 @@ To create and use a custom 404 page, do the following:
 #. Create a ``404.rst`` file next to the ``conf.py`` file.
 #. To suppress the spurious ``document isn't included in any toctree`` Sphinx
    warning, include the ``:orphan:`` attribute at the top of this ``404.rst`` file:
-   
+
    .. code-block:: rst
 
         :orphan:
-        
+
         Error 404 Not Found
         ===================
         The page you are requesting does not exist.
 
 #. Update the ``notfound_template`` variable in the ``conf.py`` to the location of
    your ``404.rst`` file:
-   
+
    .. code-block:: rst
 
         # Configure sphinx-notfound-page
diff --git a/doc/source/user_guide/autoapi.rst b/doc/source/user_guide/autoapi.rst
@@ -28,7 +28,7 @@ For example, if you are using a ``requirements.txt`` file, you would define your
 If you are using a ``pyproject.toml`` file, you would define your dependency as follows:
 
 .. code:: toml
-    
+
     # For a typical PyAnsys pyproject.toml file
     [project.optional-dependencies]
     doc = [
@@ -96,8 +96,8 @@ and set the ``ansys_sphinx_theme_autoapi`` theme options in the ``html_theme_opt
   By default, this is set to ``True``.
 - ``own_page_level``: The level of the page where the autoapi extension places the content of the class.
   By default, this is set to ``class``.
-- ``type``: The type of the autoapi extension. By default, this is set to ``python``. 
-- ``options``: The options to pass to the autoapi extension. By default, 
+- ``type``: The type of the autoapi extension. By default, this is set to ``python``.
+- ``options``: The options to pass to the autoapi extension. By default,
   this is set to ``["members", "undoc-members", "show-inheritance", "show-module-summary", "special-members"]``.
 - ``class_content``: The content of the class. By default this is set to ``class``.
 
diff --git a/doc/source/user_guide/css.rst b/doc/source/user_guide/css.rst
@@ -24,7 +24,7 @@ Here is an example that edits the ``body`` element:
      overflow: auto;
      height: calc(100vh - 3.8rem);
      overflow-y: scroll;
-   }  
+   }
    .prev-next-bottom{margin-bottom: 6rem}
 
 
diff --git a/doc/source/user_guide/extensions.rst b/doc/source/user_guide/extensions.rst
@@ -3,13 +3,13 @@
 Extensions
 ==========
 
-This page contains the shipped extensions that seamlessly integrate with this theme to enhance 
+This page contains the shipped extensions that seamlessly integrate with this theme to enhance
 documentation functionality.
 
 Linkcode extension
 -------------------
 
-The Linkcode extension automatically adds "Source" links to the documentation for Python, C, C++, 
+The Linkcode extension automatically adds "Source" links to the documentation for Python, C, C++,
 and JavaScript objects. It allows you to link to the source code hosted on GitHub.
 
 Installation
@@ -26,8 +26,8 @@ To use the ``ansys-sphinx-theme`` linkcode extension, you need to add it to the
 Configuration options
 ---------------------
 
-The Linkcode extension provides a way to configure its behavior by using certain options within your ``conf.py`` file. 
-Depending on your preferred approach, you can utilize the direct 
+The Linkcode extension provides a way to configure its behavior by using certain options within your ``conf.py`` file.
+Depending on your preferred approach, you can utilize the direct
 configuration options or the ``html_context`` dictionary to streamline your settings.
 
 If both sets of configuration options are given, the direct configuration options (that is, ``link_code_library``,
@@ -46,7 +46,7 @@ Direct configuration options
 - ``link_code_branch`` (str, optional, default: 'main'):
   The GitHub branch. It can be a specific version like ``main`` or ``dev``.
 
-If the ``link_code_source`` and ``link_code_branch`` options are not provided in the configuration, 
+If the ``link_code_source`` and ``link_code_branch`` options are not provided in the configuration,
 the following default values are used:
 
 - ``link_code_source``: An empty string (``''``). This links to the root of the repository.
@@ -61,8 +61,8 @@ the following default values are used:
 
 Using ``html_context`` dictionary
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-You also have the option to centralize your GitHub-related configuration by incorporating it 
-directly into the ``html_context`` dictionary within your ``conf.py`` file. This approach allows you to 
+You also have the option to centralize your GitHub-related configuration by incorporating it
+directly into the ``html_context`` dictionary within your ``conf.py`` file. This approach allows you to
 minimize redundancy and manage the GitHub-related information more effectively for the extension:
 
 .. code-block:: python
@@ -75,5 +75,5 @@ minimize redundancy and manage the GitHub-related information more effectively f
        "source_path": "<path-from-root-to-your-source_file>",
    }
 
-With this setup, you can fine-tune your configuration according to your preferences and requirements, 
+With this setup, you can fine-tune your configuration according to your preferences and requirements,
 enhancing the integration of the ``linkcode`` extension into your documentation.
diff --git a/doc/source/user_guide/options.rst b/doc/source/user_guide/options.rst
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/autoapi/python/class.rst b/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/autoapi/python/class.rst
diff --git a/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/autoapi/python/module.rst b/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/_templates/autoapi/python/module.rst
diff --git a/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/css/ansys_sphinx_theme.css b/src/ansys_sphinx_theme/theme/ansys_sphinx_theme/static/css/ansys_sphinx_theme.css

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+feat: adapt package to general PyAnsys repository layout`