docs: revamping example landing page and adding groups (#3434)

* docs: Adding groups to user guide * docs: adding groups to mapdl_commands * docs: adding groups to getting_started * chore: changing image resolution * docs: changing example landing page * chore: adding changelog file 3434.documentation.md * docs: removing rst comments * docs: Adding groups to user guide * docs: adding groups to mapdl_commands * docs: adding groups to getting_started * chore: changing image resolution * docs: changing example landing page * chore: adding changelog file 3434.documentation.md * docs: removing rst comments * Update doc/source/getting_started/index.rst Co-authored-by: Revathy Venugopal <[email protected]> * docs: removing unneeded section * docs: fix reference and remove link to orphan * fix: avoid showing 'Other threads are currently calling into gRPC, skipping fork() handlers' error * chore: adding link to PR in new env var --------- Co-authored-by: pyansys-ci-bot <[email protected]> Co-authored-by: Revathy Venugopal <[email protected]>
ansys · Sep 27, 2024 · ff6c564 · ff6c564
1 parent 55a59b7
commit ff6c564
Show file tree

Hide file tree

Showing 16 changed files with 112 additions and 66 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -156,6 +156,7 @@ jobs:
       PYMAPDL_DB_PORT: 21001  # default won't work on GitHub runners
       PYMAPDL_START_INSTANCE: FALSE
       ON_DOCUMENTATION: TRUE
+      GRPC_ENABLE_FORK_SUPPORT: false  # See #3434
     steps:
       - name: "Install Git and checkout project"
         uses: actions/[email protected]

diff --git a/doc/changelog.d/3434.documentation.md b/doc/changelog.d/3434.documentation.md
@@ -0,0 +1 @@
+docs: revamping example landing page and adding groups
diff --git a/doc/source/examples/index.rst b/doc/source/examples/index.rst
@@ -4,10 +4,14 @@
     :hidden:
     :maxdepth: 3
 
+    gallery_examples/00-mapdl-examples/index.rst
+    gallery_examples/01-geometry/index.rst
+    gallery_examples/02-tips-n-tricks/index.rst
+    gallery_examples/03-general-fea/index.rst
+    extended_examples/index.rst
     devportal.rst
     Verification Manual <https://examples.mapdl.docs.pyansys.com/verif-manual/index.html>
     Technology Showcases <https://examples.mapdl.docs.pyansys.com/technology_showcase_examples/index.html>
-    extended_examples/index.rst
 
 
 .. _ref_examples:
@@ -20,32 +24,67 @@ Examples
 Here are a series of examples using MAPDL with the ``ansys-mapdl-core`` library.
 
 
-.. === EXAMPLES Gallery ===
+.. grid:: 2 2 3 3
+    :gutter: 1 2 3 3
+    :padding: 1 2 3 3
+
+    .. grid-item-card:: Full examples using PyMAPDL
+        :link: sphx_glr_examples_gallery_examples_00-mapdl-examples
+        :link-type: ref
+        :img-top: ../images/examples_main_page/pymapdl.png
+
+        These examples demonstrate full examples using the PyMAPDL module.
+
+    .. grid-item-card:: Geometry examples
+        :link: sphx_glr_examples_gallery_examples_01-geometry
+        :link-type: ref
+        :img-top: ../images/examples_main_page/geometry.png
+
+        These examples demonstrate using PyMAPDL to create basic geometry.
+
+    .. grid-item-card:: Extended examples
+        :link: ref_extended_examples
+        :link-type: ref
+        :img-top: ../images/examples_main_page/extended.gif
+
+        These extended examples explain advanced concepts.
+
+    .. grid-item-card:: Miscellaneous examples
+        :link: sphx_glr_examples_gallery_examples_02-tips-n-tricks
+        :link-type: ref
+        :img-top: ../images/examples_main_page/misc.png
+
+        These examples demonstrate miscellaneous tips and tricks for using PyMAPDL.
 
-..
-   We have to include this rather than include it in a tree.
 
-.. include:: gallery_examples/index.rst
-   :start-line: 2
+    .. grid-item-card:: Academic finite element examples
+        :link: sphx_glr_examples_gallery_examples_03-general-fea
+        :link-type: ref
+        :img-top: ../images/examples_main_page/academic.png
 
+        Demonstrate finite element method for academic and teaching purposes.
 
-.. === Developer Portal examples ==
+    .. grid-item-card:: Developer portal examples
+        :link: ref_devportal_examples
+        :link-type: ref
+        :img-top: ../images/examples_main_page/developer.png
 
-.. include:: devportal.rst
-   :start-line: 2
+        Informative and insightful blog articles published in the `Developer Portal <developer_portal_>`_. 
 
+    .. grid-item-card:: Verification manual examples
+        :link: https://examples.mapdl.docs.pyansys.com/verif-manual/index.html
+        :img-top: ../images/examples_main_page/vm.png
 
-.. === PyMAPDL examples ===
+        Demonstrates a range of Mechanical APDL elements and capabilities using PyMAPDL.
 
-.. include:: pymapdl_examples_repo/index.rst
-   :start-line: 2
 
-.. === Extended examples ===
+    .. grid-item-card:: Technology Showcases
+        :link: https://examples.mapdl.docs.pyansys.com/technology_showcase_examples/index.html
+        :img-top: ../images/examples_main_page/showcase.png
 
-.. include:: extended_examples/index.rst
-   :start-line: 2
-   :end-line: 29
+        Examples coming from the APDL Technology Showcase Manual.
 
+
 
 .. === DOWNLOAD EXAMPLES ===
 

diff --git a/doc/source/examples/pymapdl_examples_repo/index.rst b/doc/source/examples/pymapdl_examples_repo/index.rst
diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst
@@ -8,17 +8,31 @@ Getting started
 .. toctree::
    :maxdepth: 1
    :hidden:
+   :caption: Introduction
 
    project
    install_mapdl
    install_pymapdl
    launcher
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Resources
+
    learning
    faq
+   versioning
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Contribute
+
    contribution
    devcontainer
    make_container
-   versioning
    docker
    macos
    wsl

diff --git a/doc/source/images/codespaces.png b/doc/source/images/codespaces.png
diff --git a/doc/source/images/examples_main_page/academic.png b/doc/source/images/examples_main_page/academic.png
diff --git a/doc/source/images/examples_main_page/developer.png b/doc/source/images/examples_main_page/developer.png
diff --git a/doc/source/images/examples_main_page/extended.gif b/doc/source/images/examples_main_page/extended.gif
diff --git a/doc/source/images/examples_main_page/geometry.png b/doc/source/images/examples_main_page/geometry.png
diff --git a/doc/source/images/examples_main_page/misc.png b/doc/source/images/examples_main_page/misc.png
diff --git a/doc/source/images/examples_main_page/pymapdl.png b/doc/source/images/examples_main_page/pymapdl.png
diff --git a/doc/source/images/examples_main_page/showcase.png b/doc/source/images/examples_main_page/showcase.png
diff --git a/doc/source/images/examples_main_page/vm.png b/doc/source/images/examples_main_page/vm.png
diff --git a/doc/source/mapdl_commands/index.rst b/doc/source/mapdl_commands/index.rst
@@ -17,6 +17,7 @@ are grouped by capability.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Session
 
    session/run_controls
    session/processor_entry
@@ -31,6 +32,7 @@ These commands are used to operate on the database globally.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Database
 
    database/setup
    database/selecting
@@ -46,6 +48,7 @@ These commands are used to control the graphics of the program.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Graphics
 
    graphics/setup
    graphics/views
@@ -64,6 +67,7 @@ These commands make up the ANSYS Parametric Design Language
 
 .. toctree::
    :maxdepth: 1
+   :caption: APDL
 
    apdl/parameter_definition
    apdl/macro_files
@@ -83,6 +87,7 @@ These commands are used to create and set up the model.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Preprocessing
 
    prep7/database
    prep7/element_type
@@ -118,6 +123,7 @@ These commands are used to load and solve the model.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Solution
 
    solution/analysis_options
    solution/nonlinear_options
@@ -158,6 +164,7 @@ processor.
 
 .. toctree::
    :maxdepth: 1
+   :caption: POST1
 
    post1/setup
    post1/controls
@@ -182,6 +189,7 @@ time-history processor.
 
 .. toctree::
    :maxdepth: 1
+   :caption: POST26
 
    post26/setup
    post26/controls
@@ -200,11 +208,11 @@ binary files produced by the program.
 
 .. toctree::
    :maxdepth: 1
+   :caption: AUX2
 
    aux2/bin_dump
    aux2/bin_manip
 
-
 ****
 AUX3
 ****
@@ -213,6 +221,7 @@ files by deleting sets or by changing values.
 
 .. toctree::
    :maxdepth: 1
+   :caption: AUX3
 
    aux3
 
@@ -225,6 +234,7 @@ analyses.
 
 .. toctree::
    :maxdepth: 1
+   :caption: AUX12
 
    aux12/general_radiation
    aux12/radiation_mat
@@ -238,6 +248,7 @@ These commands are used to read in an IGES file for analysis in ANSYS.
 
 .. toctree::
    :maxdepth: 1
+   :caption: AUX15
 
    aux15
 
@@ -250,6 +261,7 @@ onto the existing geometry.
 
 .. toctree::
    :maxdepth: 1
+   :caption: MAP
 
    map
 
@@ -266,6 +278,7 @@ produced within ANSYS.
 
 .. toctree::
    :maxdepth: 1
+   :caption: DISPLAY
 
    display/setup
 
@@ -279,6 +292,7 @@ produced within ANSYS.
 
 .. toctree::
    :maxdepth: 1
+   :caption: REDUCED
 
    reduced/setup
    reduced/preparation
@@ -293,6 +307,7 @@ These commands read in external CAD files into MAPDL.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Connection
 
    conn
 
@@ -305,6 +320,7 @@ Undocumented miscellaneous commands.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Miscellaneous
 
    misc
 
@@ -323,6 +339,7 @@ Undocumented inquire commands.
 
 .. toctree::
    :maxdepth: 1
+   :caption: Undocumented
 
    inqfun
 

diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst
@@ -10,26 +10,46 @@ This section provides a general overview of PyMAPDL and how you use it.
    This toctreemust be a top level index to get it to show up in
    pydata_sphinx_theme
 
+
 .. toctree::
    :maxdepth: 1
    :hidden:
 
+   troubleshoot
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Basic
+
    mapdl
-   convert
    mesh_geometry
    plotting
    parameters
    components
    post
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Intermediate
+
    cli
+   convert
    database
    math
    pool
+
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+   :caption: Advanced
+
    hpc
    xpl
    upf
    krylov
-   troubleshoot
 
 
 PyMAPDL overview
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		docs: revamping example landing page and adding groups