DOC: Update documentation (#4181)

dipinknair · PipKat · web-flow · commit f73d1aa1b1ba · 2024-02-02T20:29:18.000+01:00
* documentation fix

* Apply suggestions from code review

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;

* minor correction

---------

Co-authored-by: Kathy Pippert &lt;84872299+PipKat@users.noreply.github.com&gt;
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,9 +1,7 @@
 files: |
     (?x)(
         ^pyaedt/|
-        _unittest/|
-        requirements/requirements_docs.txt|
-        requirements/requirements_test.txt
+        _unittest/
     )
 exclude: |
     (?x)(
@@ -47,7 +45,6 @@ repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.5.0
   hooks:
-  - id: requirements-txt-fixer
   - id: debug-statements
   - id: trailing-whitespace
 
diff --git a/doc/source/Getting_started/Contributing.rst b/doc/source/Getting_started/Contributing.rst
@@ -68,7 +68,9 @@ For example::
   isort (python)...........................................................Passed
   flake8...................................................................Passed
   codespell................................................................Passed
-  fix requirements.txt.....................................................Passed
+  debug statements (python)................................................Passed
+  trim trailing whitespace.................................................Passed
+  Validate GitHub Workflows................................................Passed
   blacken-docs.............................................................Passed
 
 Log errors
diff --git a/doc/source/Getting_started/Installation.rst b/doc/source/Getting_started/Installation.rst
@@ -128,13 +128,12 @@ Activate virtual environment
 
     conda activate pyaedt_py310
 
-Install required packages.
-
-Download `requirements.txt <https://github.com/ansys/pyaedt/blob/main/requirements/requirements.txt>`_
+You can also install PyAEDT from Conda-Forge with this command:
 
 .. code:: bash
 
-    pip install -r requirements.txt
+    conda install -c conda-forge pyaedt
+
 
 Upgrade PyAEDT to the latest version
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/source/Getting_started/index.rst b/doc/source/Getting_started/index.rst
@@ -6,8 +6,9 @@ Getting started
    .. grid-item-card:: About PyAnsys and AEDT
             :link: About
             :link-type: doc
-
-            Learn more about PyAnsys and Ansys Electronics Desktop.
+            :margin: 2 2 0 0
+            
+            Learn more about PyAnsys and AEDT.
 
    .. grid-item-card:: Installation
             :link: Installation
diff --git a/doc/source/User_guide/index.rst b/doc/source/User_guide/index.rst
@@ -17,49 +17,49 @@ For additional practical demonstrations, see
             :link-type: doc
             :margin: 2 2 0 0
             
-            This tutorial shows how to launch Electronics Desktop and create a project.
+            How to launch AEDT and create a project.
 
    .. grid-item-card:: Modeler
             :link: modeler
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how to use 2D and 3D Modeler.
+            How to use 2D and 3D Modeler.
 
    .. grid-item-card:: Mesh
             :link: mesh
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how PyAEDT handles mesh operations.
+            How PyAEDT handles mesh operations.
 
    .. grid-item-card:: Setup
             :link: setup
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how to create a setup and run simulations.
+            How to create a setup and run simulations.
 
    .. grid-item-card:: Variables and Optimetrics
             :link: variables
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how to generate parametric models and run optimizations.
+            How to generate parametric models and run optimizations.
 
    .. grid-item-card:: Load and manage files
             :link: files
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how to load and manage input and output files.
+            How to load and manage input and output files.
 
    .. grid-item-card:: Postprocessing
             :link: postprocessing
             :link-type: doc
             :margin: 2 2 0 0
 
-            This tutorial shows how to generate reports, images, and PDF files.
+            How to generate reports, images, and PDF files.
 
 .. toctree::
    :hidden:
diff --git a/doc/source/_static/custom.css b/doc/source/_static/custom.css
@@ -13,33 +13,6 @@
     padding-top: 5em;
 }
 
-/* Remove once implemented in ansys-sphinx-theme*/
-
-.sd-card .sd-card-img-top {
-    height: 100px;
-    width: 100px;
-    margin-left: auto;
-    margin-right: auto;
-}
-
-.sd-card .sd-card-header {
-  border: none;
-  background-color:white;
-  color: #150458 !important;
-  font-size: var(--pst-font-size-h5);
-  font-weight: bold;
-  padding: .5rem 0rem 0.5rem 0rem;
-  text-align: center;
-}
-
-.sd-card .sd-card-footer .sd-card-text {
-  max-width: 220px;
-  margin-left: auto;
-  margin-right: auto;
-}
-.sd-card  .sd-card-text {
-  text-align: center;
-}
 
 nav.bd-links ul li.toctree-l1 > a {
   font-size: .90rem;
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -9,130 +9,55 @@ PyAEDT documentation  |version|
 PyAEDT is a Python library that interacts directly with the Ansys Electronics Desktop (AEDT) API,
 enabling straightforward and efficient automation in your workflow.
 
-.. grid:: 2
-
-   .. grid-item-card::
-            :img-top: _static/assets/index_getting_started.png
-
-            Getting started
-            ^^^^^^^^^^^^^^^
-
-            New to PyAEDT? This section provides the information that you need to get started with PyAEDT.
-
-            +++
-
-            .. button-link:: Getting_started/index.html
-               :color: secondary
-               :expand:
-               :outline:
-               :click-parent:
-
-                  Getting started
-
-   .. grid-item-card::
-            :img-top: _static/assets/index_user_guide.png
-
-            User guide
-            ^^^^^^^^^^
-
-            This section provides in-depth information on PyAEDT key concepts.
-
-            +++
-            .. button-link:: User_guide/index.html
-               :color: secondary
-               :expand:
-               :outline:
-               :click-parent:
-
-                  User guide
-
-
 
 .. grid:: 2
 
-   .. grid-item-card::
-            :img-top: _static/assets/index_api.png
-
-            AEDT API reference
-            ^^^^^^^^^^^^^^^^^^
+    .. grid-item-card:: Getting started :fa:`person-running`
+        :link: Getting_started/index
+        :link-type: doc
 
-            The PyAEDT API reference contains descriptions of the functions and modules included in PyAEDT.
-            It describes how the methods work and the parameter that can be used.
+        New to PyAEDT? This section provides the information that you need to get started with PyAEDT.
 
-            +++
-            .. button-link:: API/index.html
-               :color: secondary
-               :expand:
-               :outline:
-               :click-parent:
+    .. grid-item-card:: User guide :fa:`book-open-reader`
+        :link: User_guide/index
+        :link-type: doc
 
-                  AEDT API reference
+        This section provides in-depth information on PyAEDT key concepts.
 
-   .. grid-item-card::
-            :img-top: _static/assets/index_api.png
+.. grid:: 2
 
-            EDB API reference
-            ^^^^^^^^^^^^^^^^^
+    .. grid-item-card::  AEDT API reference :fa:`book-bookmark`
+        :link: API/index
+        :link-type: doc
 
-            The PyAEDT EDB API reference contains descriptions of the functions and modules included in PyAEDT.
-            It describes how the methods work and the parameter that can be used.
+        This section contains descriptions of the functions and modules included in PyAEDT.
+        It describes how the methods work and the parameter that can be used.
 
-            +++
-            .. button-link:: EDBAPI/index.html
-               :color: secondary
-               :expand:
-               :outline:
-               :click-parent:
+    .. grid-item-card::  EDB API reference :fa:`book-bookmark`
+        :link: EDBAPI/index.
+        :link-type: doc
 
-                  EDB API reference
+        Contains descriptions of the functions and modules included in PyEDB.
+        It describes how the methods work and the parameter that can be used.
 
 .. jinja:: main_toctree
 
-    .. grid:: 2
-
-           {% if run_examples %}
-           .. grid-item-card::
-                    :img-top: _static/assets/index_examples.png
-
-                    Examples
-                    ^^^^^^^^
-
-                    Explore examples that show how to use PyAEDT to
-                    perform different types of simulations.
-
-                    +++
-                    .. button-link:: examples/index.html
-                       :color: secondary
-                       :expand:
-                       :outline:
-                       :click-parent:
-
-                          Examples
-           {% endif %}
-
-        .. grid-item-card::
-                :img-top: _static/assets/index_contribute.png
-
-                Contribute
-                ^^^^^^^^^^
-                Learn how to contribute to the PyAEDT codebase
-                or documentation.
+   .. grid:: 2
 
-                +++
-                .. button-link:: Getting_started/Contributing.html
-                   :color: secondary
-                   :expand:
-                   :outline:
-                   :click-parent:
+      {% if run_examples %}
+      .. grid-item-card:: Examples :fa:`scroll`
+         :link: examples/index
+         :link-type: doc
 
-                      Contribute
+         Explore examples that show how to use PyAEDT to perform different types of simulations.
+      
+      {% endif %}
 
-Indices and tables
-==================
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+      .. grid-item-card:: Contribute :fa:`people-group`
+         :link: Getting_started/Contributing
+         :link-type: doc
 
+         Learn how to contribute to the PyAEDT codebase or documentation.
 
 .. jinja:: main_toctree
 
