Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API warning #1613

Merged
merged 4 commits into from
Feb 5, 2024
Merged

Add API warning #1613

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3c15d5
Add API warning
brycegbrazen Jan 8, 2024
dd0b1a5
Add warning tag
brycegbrazen Jan 29, 2024
e873ce8
Apply suggestions from code review
JeanChristopheMorinPerso Feb 5, 2024
ecb556c
Update docs/source/api.rst
JeanChristopheMorinPerso Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@
Python API
==========

.. warning::

WARNING
=======
Please note the following warnings prior to using the Rez Python API:

* We try our best to not break users, but there are no compatibility guarantees between different versions of Rez.
* The Python API does not currently support rereading from configuration files, or changing to new configuration files after the Python API has initially been imported. If you need to support this functionality, prefer the CLI instead.

.. autosummary::
:toctree: api
:recursive:
Expand Down