updated docs

Davide-sd · Nov 6, 2024 · 2dc8b20 · 2dc8b20
1 parent 8e96f59
commit 2dc8b20
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 5 deletions.
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -6,4 +6,5 @@ nbsphinx
 nbsphinx_link
 sphinx-rtd-theme
 cantera
-jinja2
+jinja2
+sphinx_design
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -60,6 +60,12 @@
     'sphinx_rtd_theme',
     'nbsphinx',
     'nbsphinx_link', # to link to ipynb files outside of the source folder
+    'sphinx_design',
+]
+
+# in order to show the icons on sponsorship buttons
+html_css_files = [
+    "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.1.1/css/all.min.css"
 ]
 
 # hide the table inside classes autodoc

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -25,7 +25,7 @@ pygasflow provides a few handful functions to quickly perform:
   * Correlations to estimate boundary layer thickness, heat flux and wall
     shear stress over a flat plate or a stagnation region.
   * Newtonian Flow Theory to estimate the pressure distribution around
-    objects and their aerodynamic characteristics. 
+    objects and their aerodynamic characteristics.
 
 The following charts has been generated with the functions included in this package:
 
@@ -54,6 +54,30 @@ The following charts has been generated with the functions included in this pack
    :alt: Shock Reflection
 
 
+Development and Support
+=======================
+
+If you feel like a feature could be implemented, open an issue or create a PR.
+
+If you really want a new feature but you don't have the capabilities or the
+time to make it work, I'm willing to help; but first, open an issue or send
+me an email so that we can discuss a sponsorship strategy.
+
+Developing this module and its documentation was no easy job. Implementing
+new features and fixing bugs requires time and energy too. If you found this
+module useful and would like to show your appreciation, please consider
+sponsoring this project with either one of these options:
+
+.. button-link:: https://www.buymeacoffee.com/davide_sd
+    :color: primary
+
+    :fas:`mug-hot;fa-xl` Buy me a Coffee
+
+.. button-link:: https://github.com/sponsors/Davide-sd
+    :color: primary
+
+    :fab:`github;fa-xl` Github Sponsor :fas:`heart;fa-xl`
+
 
 .. toctree::
    :maxdepth: 2

diff --git a/examples/06_Shock_Wave_Pressure_Deflection_Diagram.ipynb b/examples/06_Shock_Wave_Pressure_Deflection_Diagram.ipynb
@@ -178,7 +178,8 @@
     "plt.grid(which='minor', linestyle=':', alpha=0.5)\n",
     "plt.xlabel(r\"Deflection Angle $\\theta$ [deg]\")\n",
     "plt.ylabel(\"Pressure Ratio\")\n",
-    "plt.title(\"Shock Reflection Process\")"
+    "plt.title(\"Shock Reflection Process\")\n",
+    "plt.show()"
    ]
   },
   {
@@ -205,7 +206,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.12.3"
   },
   "toc": {
    "base_numbering": 1,
@@ -222,5 +223,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 2
+ "nbformat_minor": 4
 }