DOC: enable panels in documentation landing page (#104)

Revathyvenugopal162 · RobPasMue · jorgepiloto · web-flow · commit f158cf099b0b · 2022-12-02T11:33:16.000+01:00
Co-authored-by: Roberto Pastor Muela &lt;roberto.pastormuela@ansys.com&gt;
Co-authored-by: Jorge Martínez &lt;28702884+jorgepiloto@users.noreply.github.com&gt;
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -9,9 +9,11 @@ repos:
   rev: 5.10.1
   hooks:
   - id: isort
+    args:
+      - --line-length=88
 
 - repo: https://github.com/PyCQA/flake8
-  rev: 5.0.4
+  rev: 6.0.0
   hooks:
   - id: flake8
 
diff --git a/README.rst b/README.rst
@@ -1,3 +1,4 @@
+.. readme_common_begins
 PyAnsys Actions
 ===============
 |pyansys| |MIT|
@@ -14,4 +15,5 @@ A repository containing a collection of `GitHub Workflows
 <https://docs.github.com/en/actions/using-workflows/about-workflows>`_ to be
 reused by projects in the PyAnsys ecosystem.
 
+.. readme_common_ends
 For more information on available actions and how to use them, see `actions.docs.pyansys.com <https://actions.docs.pyansys.com>`_ .
diff --git a/build-wheelhouse/action.yml b/build-wheelhouse/action.yml
@@ -57,7 +57,7 @@ runs:
       shell: bash
       run: pip install ${{ env.install_target }}
 
-    - name: "Verify libray is properly installed and get its version number"
+    - name: "Verify library is properly installed and get its version number"
       shell: bash
       run: |
         echo "library_version=$(python -c "from ${{ inputs.library-namespace }} import __version__; print(__version__)")" >> $GITHUB_ENV
diff --git a/doc/source/build-actions/index.rst b/doc/source/build-actions/index.rst
@@ -55,7 +55,7 @@ Here is a code sample for using this action:
           uses: pyansys/actions/build-wheelhouse@main
           with:
             library-name: "<ansys-product-library>"
-            library-namespace: "<ansys.product.libray>"
+            library-namespace: "<ansys.product.library>"
             operating-system: ${{ matrix.os }}
             python-version: ${{ matrix.python-version }}
 
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -42,6 +42,7 @@
     "sphinx.ext.autosectionlabel",
     "sphinx_copybutton",
     "sphinx_jinja",
+    "sphinx_design",
 ]
 
 # Specify the static path
diff --git a/doc/source/doc-actions/index.rst b/doc/source/doc-actions/index.rst
@@ -128,7 +128,7 @@ for which the documentation is being build is not public yet. For those cases, t
 multi-version mechanism (which the previous actions assume) is not allowed.
 
 The way PyAnsys libraries handle documentation deployment while being private/internal is
-by releasing its documentation to dedicated repositories: one for the dev documetation, and
+by releasing its documentation to dedicated repositories: one for the dev documentation, and
 a different one for the stable (or internally released) documentation. This action intends
 to allow users to specify which repository they intend to release their docs to.
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,4 +1,50 @@
 .. include:: ../../README.rst
+   :start-after: .. readme_common_begins
+   :end-before: .. readme_common_ends
+
+For more information on available actions and how to use them,
+see each card below:
+
+.. grid:: 1 1 2 2
+    :gutter: 2
+
+    .. grid-item-card:: :octicon:`codescan-checkmark` Style actions
+       :link: style-actions/index
+       :link-type: doc
+
+        Style actions verify code and documentation.
+
+    .. grid-item-card:: :octicon:`tools` Tests actions
+       :link: tests-actions/index
+       :link-type: doc
+
+        Tests actions allow to run the test suite.
+
+    .. grid-item-card:: :octicon:`book` Docs actions
+       :link: doc-actions/index
+       :link-type: doc
+
+        Documentation actions build and deploy the documentation.
+
+    .. grid-item-card:: :octicon:`key` Licence actions
+       :link: licenses-actions/index
+       :link-type: doc
+
+        Licence actions sallows to verify that the project’s dependencies only contain valid licenses.
+
+
+    .. grid-item-card:: :octicon:`package` Build actions
+       :link: build-actions/index
+       :link-type: doc
+
+        Build actions allow for building artifacts.
+
+    .. grid-item-card:: :octicon:`eye` Release actions
+       :link: release-actions/index
+       :link-type: doc
+
+        Release actions provide for releasing the various artifacts.
+
 
 .. toctree::
    :hidden:
diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt
@@ -3,4 +3,5 @@ pyyaml==6.0.0
 Sphinx==5.3.0
 sphinx-copybutton==0.5.1
 sphinx-jinja==2.0.2 
+sphinx_design==0.3.0
 tabulate==0.9.0
diff --git a/scripts/version_mapper.py b/scripts/version_mapper.py
@@ -93,7 +93,7 @@ def update_switch_version_file(
         # Update JSON file with the new content
         json.dump(new_content, switcher_file, indent=4)
 
-    # Use the latest stable verion for formatting the announcement
+    # Use the latest stable version for formatting the announcement
     announcement_link = (
         f"<a href='{cname}/release/{latest_stable_version}'>{latest_stable_version}</a>"
     )

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@`
`42`	`42`	`"sphinx.ext.autosectionlabel",`
`43`	`43`	`"sphinx_copybutton",`
`44`	`44`	`"sphinx_jinja",`
	`45`	`+ "sphinx_design",`
`45`	`46`	`]`
`46`	`47`
`47`	`48`	`# Specify the static path`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@ def update_switch_version_file(`
`93`	`93`	`# Update JSON file with the new content`
`94`	`94`	`json.dump(new_content, switcher_file, indent=4)`
`95`	`95`
`96`		`- # Use the latest stable verion for formatting the announcement`
	`96`	`+ # Use the latest stable version for formatting the announcement`
`97`	`97`	`announcement_link = (`
`98`	`98`	`f"<a href='{cname}/release/{latest_stable_version}'>{latest_stable_version}</a>"`
`99`	`99`	`)`