Unify Python library diagrams

Author: jorgepiloto

doc/source/packaging/diagrams/ansys_project_diagram.rst

@@ -1,6 +1,6 @@
 .. _high level pyansys structure:
 .. graphviz::
-    :caption: High-level structure of a PyAnsys project
+    :caption: A PyAnsys project is composed by a Python library and other files.
     :alt: High-level structure of a PyAnsys project
     :align: center
 

doc/source/packaging/diagrams/python_elements_diagram.rst

@@ -1,7 +1,7 @@
 .. _python pkg lib diagram:
 .. graphviz::
-    :caption: Difference between Python library and package
-    :alt: Difference between Python library and package
+    :caption: A Python library is a collection of packages.
+    :alt: A Python library is a collection of packages.
     :align: center
 
      digraph "sphinx-ext-graphviz" {
@@ -30,11 +30,37 @@
            label="...", shape="folder"
          ];
 
-
          python_library -> pkg_A
          python_library -> pkg_B
          python_library -> pkg_other
 
+         sub_package [
+           label="Sub-package A", shape="folder"
+         ];
+
+         init_file1 [
+           label="__init__.py", shape="file"
+         ];
+
+         init_file2 [
+           label="__init__.py", shape="file"
+         ];
+
+         module_foo [
+           label="module_foo.py", shape="file"
+         ];
+
+         module_bar [
+           label="module_bar.py", shape="file"
+         ];
+
+         pkg_A -> sub_package;
+         pkg_A -> init_file1;
+         pkg_A -> module_foo;
+
+         sub_package -> init_file2;
+         sub_package -> module_bar;
+
      }
 
 

doc/source/packaging/diagrams/python_pkg_lib_diagram.rst renamed to doc/source/packaging/diagrams/python_library_diagram.rst

@@ -31,15 +31,12 @@ Scripts, Modules, Sub-packages, and Packages
 
 To understand the structure of a Python Library, it is important to know
 the difference between Python scripts, modules, sub-packages, and packages.
-Figure :numref:`python elements diagram` provides a graphical interpretation.
 
 * ``Script``: Any Python file with logic source code.
 * ``Module``: Any Python script hosted next to an ``__init__.py`` file.
 * ``Sub-package``: Any directory containing various Python modules.
 * ``Package``: Any directory containing Python modules and sub-packages.
 
-.. include:: diagrams/python_elements_diagram.rst
-
 
 Differences Between a Python Package and Library
 ------------------------------------------------
@@ -49,20 +46,7 @@ them: a Python package is a collection of Python modules and sub-packages while
 a Python Library is a collection of Python packages. Figure :numref:`python pkg
 lib diagram` exposes this.
 
-.. include:: diagrams/python_pkg_lib_diagram.rst
-
-
-Other Files
-===========
-
-Additional files can be stored next to a Python Library. These files will not be
-included when distributing the library. Most of these files are metadata, tool
-configuration files, and CI workflows definitions.
-
-.. tip::
-
-   Avoid having lots of additional files. This reduces mainteinance tasks and
-   provides a clean root project directory.
+.. include:: diagrams/python_library_diagram.rst
 
 
 Required Files for a PyAnsys Project