schrodinger.utils.documentation module

schrodinger.utils.documentation.show_topic(topic_name)[source]

Opens a window to display the help topic. :param topic_name Name of help topic :type topic_name str

schrodinger.utils.documentation.show_python_api()[source]

Opens a browser to display local python API.

schrodinger.utils.documentation.show_python_overview()[source]
schrodinger.utils.documentation.show_contact_info()[source]
schrodinger.utils.documentation.show_manuals_index()[source]
schrodinger.utils.documentation.show_knowledge_base(context='')[source]
schrodinger.utils.documentation.show_new_features(context='')[source]
schrodinger.utils.documentation.show_new_maestro_features(context='')[source]
schrodinger.utils.documentation.show_known_issues(context='')[source]
schrodinger.utils.documentation.show_canvas_user_manual()[source]
schrodinger.utils.documentation.show_elements_visualization_tutorial()[source]
schrodinger.utils.documentation.show_elements_task_tutorial()[source]
schrodinger.utils.documentation.show_about_utilities()[source]
schrodinger.utils.documentation.show_maestro_training_videos(context='')[source]
schrodinger.utils.documentation.show_knime_workflows()[source]
schrodinger.utils.documentation.open_url(url, show_warning=True, fragment=None)[source]
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

schrodinger.utils.documentation.show_message(message)[source]