MAINT: add typehint example (#169)

* add typehint in plot_contour to test extension

* add autodoc_typehints variable

* follow exact notation in sphinx-autodoc-typehints documentation

* working version when docs generated locally

* typehints example in plot_contour

* fix style

* remove Optional

* remove Optional

Co-authored-by: PProfizi <[email protected]>

Author: GuillemBarroso

.gitignore

@@ -71,7 +71,9 @@ instance/
 .scrapy
 
 # Sphinx documentation
-doc/build/
+docs/build/
+docs/source/api/_autosummary
+docs/source/examples
 
 # PyBuilder
 .pybuilder/

docs/source/conf.py

@@ -55,6 +55,9 @@
     "sphinx_gallery.gen_gallery",
 ]
 
+typehints_defaults = "comma"
+simplify_optional_unions = False
+
 # Intersphinx mapping
 intersphinx_mapping = {
     "python": ("https://docs.python.org/dev", None),

requirements/requirements_docs.txt

@@ -11,4 +11,4 @@ sphinx-notfound-page==0.8.3
 sphinx-copybutton==0.5.0
 sphinx-gallery==0.11.1
 ansys_sphinx_theme==0.6.0
-sphinx-autodoc-typehints
+sphinx-autodoc-typehints==1.19.1

src/ansys/dpf/post/result_data.py

@@ -322,7 +322,7 @@ def _sort_fields_container_with_labels(self, option_id, display_option):
             new_fields_container.add_field(label, field)
         return new_fields_container
 
-    def plot_contour(self, display_option: str = "time", option_id=1, **kwargs):
+    def plot_contour(self, display_option: str = "time", option_id: int = 1, **kwargs):
         """Plot the contour result on its mesh support.
 
         The obtained figure depends on the support, which can be a
@@ -333,11 +333,11 @@ def plot_contour(self, display_option: str = "time", option_id=1, **kwargs):
 
         Parameters
         ----------
-        display_option : str, optional
-            Name of the label to display. The default is ``"time"``.
-        option_id: int, optional
-            Label ID to display. The default is ``1``.
-        **kwargs : optional
+        display_option :
+            Name of the label to display.
+        option_id :
+            Label ID to display.
+        **kwargs :
             Additional keyword arguments for the plotter. For keyword
             arguments, see ``help(pyvista.plot)``.