Move numpydoc validation to doc formatting tools

Author: jorgepiloto

doc/source/doc-style/docstrings.rst

@@ -1,20 +1,8 @@
-Numpydoc docstrings
+Numpydoc Docstrings
 ###################
 
 When writing docstrings for PyAnsys libraries, use the `numpydoc`_
-style, regardless as to whether you are using this Sphinx extension or the 
-`napoleon <https://pypi.org/project/sphinxcontrib-napoleon/>`_ Sphinx extension
-to generate your library documentation.
-
-You add the extension to use for documentation generation in your ``conf.py`` file.
-For example, to use `numpydoc`_, you would add:
-
-.. code:: python
-
-  extensions = [
-      'numpydoc',
-      ...
-  ]
+style. 
 
 For consistency within PyAnsys libraries, always use ``"""`` to introduce and conclude a
 docstring, keeping the line length shorter than 70 characters. Ensure that there are

doc/source/doc-style/formatting-tools.rst

@@ -72,6 +72,41 @@ Alternate tools to `interrogate`_ are `docstr-coverage`_ and
 output resembling that of `pytest-cov`_, which is the the equivalent tool
 for source code coverage.
 
+Numpydoc Validation
+-------------------
+In order to validate the style of :ref:`Numpydoc Docstrings`, it is possible to
+take advantage of `numpydoc`_ Sphinx extension. Note that this extension will
+only check for those objcts whose docstring needs to be rendered. It is not a
+command line tool which checks all docstrings style in your source code.
+
+Because it is a Sphinx extension, it needs to be configured via through the
+``conf.py``.  see :ref:`The \`\`doc/\`\` directory`. Start by adding it to the
+list of extensions:
+
+.. code-block:: python
+
+  extensions = [
+      'numpydoc',
+      ...
+  ]
+
+Once added, you can select which `validation checks
+<https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks>`_
+need to be addressed by using the ``numpydoc_validation_checks`` dictionary:
+
+.. code-block:: python
+
+   numpydoc_validation_checks = {"GL08"}
+
+This will issue the following warning for any object without a docstring:
+
+.. code-block:: python
+
+   "The object does not have a docstring"
+
+For a complete list of available checks, please check the `full mapping of
+validation checks
+<https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks>`_.
 
 Pydocstyle
 ----------
@@ -98,3 +133,4 @@ under the ``[tool.pydocstyle]`` entry:
 .. _docformatter: https://github.com/PyCQA/docformatter
 .. _codespell: https://github.com/codespell-project/codespell
 .. _pytest-cov: https://pytest-cov.readthedocs.io/en/latest/
+.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html

doc/source/doc-style/index.rst

@@ -31,7 +31,7 @@ The documentation for a PyAnsys library should contain:
 Finally, the documentation should be public and hosted via gh-pages, either as
 a branch named ``gh-pages`` within the library repository or within a
 ``gh-pages`` branch within ``<library-repository>-docs``. For more information,
-see :ref:`documentation_deployment`.
+see :ref:`Continuous Documentation Deployment`.
 
 .. toctree::
    :hidden: