diff --git a/news/profile-docstring.rst b/news/profile-docstring.rst new file mode 100644 index 0000000..de444e5 --- /dev/null +++ b/news/profile-docstring.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/diffpy/cmi/profilesmanager.py b/src/diffpy/cmi/profilesmanager.py index 533b239..eee2826 100644 --- a/src/diffpy/cmi/profilesmanager.py +++ b/src/diffpy/cmi/profilesmanager.py @@ -45,6 +45,19 @@ class Profile: Extra requirement lines (scripts or packages). source : path-like Absolute path to the YAML file that defined the profile. + + Profile Format + -------------- + All profile `.yaml` files must have the following structure:: + + packs: + - + + extras: + - + + The file name is the profile identifier used for installing profiles. + See `requirements/profiles/all.yml` for an example. """ name: str