@@ -5,25 +5,25 @@ Project Structure
5
5
#################
6
6
7
7
Most of the projects in the PyAnsys ecosystem ship in the form of a Python
8
- Package . This is the formal way of distributing Python-based projects.
8
+ package . This is the formal way of distributing Python-based projects.
9
9
10
10
The guide presented in this page is compliant with the `Python Packaging
11
- Authority `_ and the `PyAnsys `_ recommendations.
11
+ Authority `_ and `PyAnsys `_ recommendations.
12
12
13
13
.. note ::
14
14
15
- The best way to keep up-to- date with Python Packaging is to check the `Python
15
+ The best way to keep up to date with Python packaging is to check the `Python
16
16
Packaging User Guide `_, maintained by the `Python Packaging Authority `_ (PyPA).
17
- PyAnsys guidelines are build on top of PyPA ones .
17
+ PyAnsys guidelines are built on top of PyPA guidelines .
18
18
19
19
20
20
.. TODO: Explain the difference between Package and Library?
21
21
Package: only holds modules
22
22
Library: a collection of packages
23
23
24
24
25
- PyAnsys Project Required Files
26
- ==============================
25
+ Required Files for a PyAnsys Project
26
+ ====================================
27
27
28
28
The fundamental PyAnsys Library structure is composed by the following files and
29
29
directories:
@@ -53,16 +53,13 @@ directories:
53
53
├── pyproject.toml
54
54
└── setup.py (optional)
55
55
56
- The following directories can be identified in previous structure:
56
+ Descriptions follow for some of the directories in the structure:
57
57
58
- - ``doc/ `` is devoted to store any piece of information related to documentation,
59
- guidelines and examples.
58
+ - ``doc/ `` contains files related to documentation, guidelines, and examples.
60
59
61
- - ``src/ `` is used to collect all the Python modules and scripts that form
62
- the project.
60
+ - ``src/ `` contains all Python modules and scripts that form the project.
63
61
64
- - ``tests/ `` stores all the unit tests whose purpose is to check the integrity
65
- of the project.
62
+ - ``tests/ `` contains all unit tests for checking the integrity of the project.
66
63
67
64
68
65
The ``doc/ `` Directory
0 commit comments