Embedd examples inside documentation (#84)

* Adding server run to the docs

* Allowing examples rendering

* Always upload server docs

* Include examples in docs

* Adding missing README

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Rename Readme.txt to README.txt

* Missing imports

* Ignoring solver examples folder

Author: RobPasMue

.github/workflows/ci_cd.yml

@@ -49,6 +49,13 @@ jobs:
           pip install --upgrade build
           pip install .[doc]
 
+      - name: Run server
+        run: |
+          cd src/ansys/dyna/core/pre/Server
+          python kwserver.py > server_output_docs.txt &
+          sleep 10
+          cd -
+
       - name: Build the documentation
         run: |
           xvfb-run make -C doc html
@@ -60,6 +67,13 @@ jobs:
           path: doc/_build/html
           retention-days: 7
 
+      - name: Upload the server logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: server-logs-docs
+          path: src/ansys/dyna/core/pre/Server/server_output_docs.txt
+
   style:
     name: Code style
     runs-on: ubuntu-latest

doc/source/conf.py

@@ -6,6 +6,7 @@
 import pyvista
 from ansys_sphinx_theme import pyansys_logo_black, ansys_favicon
 from sphinx.builders.latex import LaTeXBuilder
+from sphinx_gallery.sorting import FileNameSortKey
 
 from ansys.dyna.core import __version__
 
@@ -51,8 +52,7 @@ def get_version_match(semver):
             # convert rst to md for ipynb
             "pypandoc": True,
             # path to your examples scripts
-            # "examples_dirs": ["../../examples/"],
-            "examples_dirs": [],
+            "examples_dirs": ["../../examples/"],
             # path where to save gallery generated examples
             "gallery_dirs": ["examples"],
             # Patter to search for examples files
@@ -62,11 +62,11 @@ def get_version_match(semver):
             # Remove the "Download all examples" button from the top level gallery
             "download_all_examples": False,
             # Sort gallery examples by file name instead of number of lines (default)
-            #"within_subsection_order": FileNameSortKey,
+            "within_subsection_order": FileNameSortKey,
             # directory where function granular galleries are stored
             "backreferences_dir": None,
             # Modules for which function level galleries are created.  In
-            "doc_module": "ansys-mapdl-core",
+            "doc_module": "ansys-dyna-core",
             "image_scrapers": ("pyvista", "matplotlib"),
             "thumbnail_size": (350, 350),
             # 'first_notebook_cell': ("%matplotlib inline\n"

doc/source/index.rst

@@ -10,3 +10,4 @@ PyDyna documentation  0.0.1
    Resources/User_Guide
    API/index
    Resources/Contributing
+   examples/index