schrodinger.utils.documentation module¶
- schrodinger.utils.documentation.get_topic_fragment(topic_name: str) str[source]¶
Returns topic fragment (relative path of topic file) Raise RuntimeError if docs folder is not present. :param topic_name: is help topic ID. :return: relative path of topic file.
- schrodinger.utils.documentation.show_local_doc(relative_file_path: str)[source]¶
Shows help topic webpage from local docs ($SCHRODINGER/docs). Raises RuntimeError if help topic file is not found. :param relative_file_path: is path to help topic webpage.
- schrodinger.utils.documentation.is_internet_available() bool[source]¶
Returns True if access to www.schrodinger.com is available False otherwise
- schrodinger.utils.documentation.show_topic(topic_name: str) str[source]¶
Opens a window to display the help topic. It will try to look for online docs, if not able to show then fallback to search for local docs present inside $SCHRODINGER/docs. In case both are not available warns user. :param topic_name Name of help topic
- schrodinger.utils.documentation.show_python_api()[source]¶
Opens a browser to display local python API.
- schrodinger.utils.documentation.show_online_tutorials(key)[source]¶
Shows online tutorials according to profile key value present in DOCUMENTATION_LINKS dictionary. :param key: is key for help action. :type key: str
- schrodinger.utils.documentation.openTempURL(qurl)[source]¶
Create a temporary file containing HTML and open it in browser
The HTML redirects the browser to the appropriate url. This circumvents a bug in Windows and MacOS that chops off the anchor of a URL if the URL points to a local file.
- Parameters
qurl (QtCore.QUrl) – The QUrl to redirect to
- Returns
Success of opening the temp URL
- Return type
bool