diff --git a/doc/source/abstraction/index.rst b/doc/source/abstraction/index.rst deleted file mode 100644 index f8692c112..000000000 --- a/doc/source/abstraction/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -Abstraction and Encapsulation -############################# -Abstraction in Python is the process of hiding the real implementation -of an application from the user and emphasizing only usage. - -One of the main objectives of PyAnsys libraries is to wrap (encapsulate) -data and methods within units of execution while hiding data or parameters -in protected variables. - -The topics in this section demonstrate how applications and complex services -expose functionalities that matter to users and hide all else. For example, -background details, implementation, and hidden states can all be hidden. - -.. toctree:: - :hidden: - :maxdepth: 3 - - app_interface_abstraction - service_abstraction - data_transfer_and_representation - diff --git a/doc/source/abstraction/app_interface_abstraction.rst b/doc/source/guidelines/app_interface_abstraction.rst similarity index 100% rename from doc/source/abstraction/app_interface_abstraction.rst rename to doc/source/guidelines/app_interface_abstraction.rst diff --git a/doc/source/abstraction/data_transfer_and_representation.rst b/doc/source/guidelines/data_transfer_and_representation.rst similarity index 100% rename from doc/source/abstraction/data_transfer_and_representation.rst rename to doc/source/guidelines/data_transfer_and_representation.rst diff --git a/doc/source/overview/dev_practices.rst b/doc/source/guidelines/dev_practices.rst similarity index 100% rename from doc/source/overview/dev_practices.rst rename to doc/source/guidelines/dev_practices.rst diff --git a/doc/source/guidelines/index.rst b/doc/source/guidelines/index.rst new file mode 100644 index 000000000..89d0a8f80 --- /dev/null +++ b/doc/source/guidelines/index.rst @@ -0,0 +1,20 @@ +Guidelines +############################# +The purpose of this section is to highligh some common practices that +can be applied to the entire PyAnsys project in order to remain consistent. + +One of the main objectives of PyAnsys libraries is to wrap (encapsulate) +data and methods within units of execution while hiding data or parameters +in protected variables. + +Those guidelines demonstrate how applications and complex services expose +functionalities such as logging, data transfer... + +.. toctree:: + :hidden: + :maxdepth: 3 + + dev_practices + app_interface_abstraction + service_abstraction + data_transfer_and_representation diff --git a/doc/source/abstraction/service_abstraction.rst b/doc/source/guidelines/service_abstraction.rst similarity index 100% rename from doc/source/abstraction/service_abstraction.rst rename to doc/source/guidelines/service_abstraction.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 456705b86..869f0064d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,7 +8,7 @@ :maxdepth: 3 overview/index + guidelines/index library_description/index - abstraction/index coding_style/index documentation_style/index diff --git a/doc/source/overview/index.rst b/doc/source/overview/index.rst index c929c746d..ed8dc0e86 100644 --- a/doc/source/overview/index.rst +++ b/doc/source/overview/index.rst @@ -66,7 +66,6 @@ PROTO files, create coverage reports, and report on system coverage: basic administration contributing - dev_practices .. _PyAEDT: https://github.com/pyansys/PyAEDT .. _PyMAPDL: https://github.com/pyansys/pymapdl