Skip to content

Commit dbcc850

Browse files
committed
profile format docstring
1 parent 6c1ca2c commit dbcc850

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/diffpy/cmi/profilesmanager.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,19 @@ class Profile:
4545
Extra requirement lines (scripts or packages).
4646
source : path-like
4747
Absolute path to the YAML file that defined the profile.
48+
49+
Profile Format
50+
--------------
51+
All profile `.yaml` files must have the following structure::
52+
53+
packs:
54+
- <pack_name>
55+
56+
extras:
57+
- <additional_package_name>
58+
59+
The file name is the profile identifier used for installing profiles.
60+
See `requirements/profiles/all.yml` for an example.
4861
"""
4962

5063
name: str

0 commit comments

Comments
 (0)