Public API¶
repo_helper_pycharm.docs
¶
Parse PyCharm configuration and open a project’s documentation in the default web browser.
New in version 0.2.0.
Functions:
Returns the path to the PyCharm configuration directory. |
|
Returns the number of the port used by the PyCharm web server. |
|
|
Opens the URL in the browser configured in the PyCharm settings. |
-
get_config_dir
()[source]¶ Returns the path to the PyCharm configuration directory.
New in version 0.2.0.
- Raises
FileNotFoundError
if the directory can’t be found.- Return type
repo_helper_pycharm.iml_manager
¶
Class to update PyCharm’s *.iml
configuration files.
Classes:
|
Class to update PyCharm’s |
-
class
ImlManager
(repo_dir)[source]¶ Bases:
object
Class to update PyCharm’s
*.iml
configuration files.Methods:
Remove any existing option for “PyDocumentationSettings”, to revert to the default of reStructuredText.
run
([show_diff])Update the configuration in the file.
Update the list of directories which should be excluded from indexing.
Set the project’s test runner to pytest.
write_out
([show_diff])Write the modified output to file.
-
remove_docstring_format
()[source]¶ Remove any existing option for “PyDocumentationSettings”, to revert to the default of reStructuredText.
-
repo_helper_pycharm.register_schema
¶
Register the schema mapping for repo_helper.yml
with PyCharm.
Functions:
|
Register the schema mapping for |