JetBrains
jetbrains.com › help › pycharm › getting-started.html
Getting started | PyCharm Documentation
Need help? Here is the complete coverage for all JetBrains products, languages, and tools.
JetBrains
jetbrains.com › help › pycharm › quick-start-guide.html
Quick start guide | PyCharm Documentation
1 month ago - Learn how to create new projects, open existing projects, use coding assistance, work with Git, process data, customize appearance and shortcuts.
Videos
20:37
Update Python and PyCharm for Building Documentation - YouTube
01:08
How to view arguments and documentation without interrupting your ...
10:00
PyCharm Tutorial | Introduction to PyCharm | Basics in 10 Minutes ...
Getting Started with PyCharm!
Pycharm Tutorial #1 - Setup & Basics
PyCharm Tip: Quick Documentation (F1) lets you peek at your API ...
JetBrains
jetbrains.com › help › pycharm › viewing-reference-information.html
Code reference information | PyCharm Documentation
1 month ago - Basic procedures to view definition, documentation, and parameters of a symbol in PyCharm.
JetBrains
jetbrains.com › help › pycharm › inline-documentation.html
Viewing Inline Documentation | PyCharm Documentation
March 6, 2026 - Find out how you can view documentation for various code symbols in PyCharm: learn the shortcuts, configure the popup, font size, and more.
JetBrains
jetbrains.com › help › pycharm › documentation-tool-window.html
Documentation tool window | PyCharm Documentation
By default, PyCharm shows Quick Documentation in a popup; to view it in the tool window, click in the popup and choose Open in Documentation Tool Window or press Ctrl+Q twice.
JetBrains
jetbrains.com › help › pycharm › creating-documentation-comments.html
Create documentation comments | PyCharm Documentation
January 21, 2026 - Place the caret after the declaration ... want to document. Type opening triple quotes, and press Enter, or Space. ... Generation of docstrings on pressing Space after typing opening triple quotes only works when the checkbox Insert pair quote is cleared in the page Smart Keys of the editor settings . If you rename a parameter of a function, PyCharm will ...
JetBrains
jetbrains.com › help › pycharm › generating-reference-documentation.html
Generate reference documentation | PyCharm Documentation
August 4, 2025 - The documentation generators should be properly installed on your machine. For more information, refer to their respective download and installation pages. PyCharm recognizes the docstring format and uses the documentation source directory defined in the Integrated Tools page of the Settings dialog.
JetBrains
jetbrains.com › help › pycharm › settings-tools-python-external-documentation.html
External Documentation | PyCharm Documentation
June 4, 2025 - To view Python external documentation, you need to configure the documentation URL first. PyCharm comes with the URLs for pandas, wx, kivy, PySide, PyQt5, PyQt4, matplotlib, pyramid, flask, and gtk.
JetBrains
jetbrains.com › help › pycharm › python.html
Python | PyCharm Documentation
To develop Python scripts in PyCharm: Download and install Python. Configure at least one Python interpreter. If you are a Windows user, we recommend that you install Python for Windows. Python 2: version 2.7 · Python 3: from the version 3.9 up to the version 3.15 ·
JetBrains
jetbrains.com › help › pycharm › documenting-source-code.html
Document source code | PyCharm Documentation
January 20, 2026 - Documentation comments can be created in accordance with the syntax, selected in the Python Integrated Tools page of the project settings (Ctrl+Alt+S). If this feature applies to a function, PyCharm generates tags, depending on the selected docstring format.
JetBrains
jetbrains.com › pycharm › learn
Learn PyCharm
June 2, 2021 - Intelligent Python IDE with refactorings, debugger, code completion, on-the-fly code analysis and coding productivity orientation
Medium
medium.com › @djnrrd › automatic-documentation-with-pycharm-70d37927df57
Automatic Documentation with PyCharm | by DJ Nrrd | Medium
April 21, 2020 - Automatic Documentation with PyCharm If you’re starting to up your python game from little scripts you’ve put together in a text editor into working with IDEs and “doing it right” then …
JetBrains
jetbrains.com › help › pycharm › installation-guide.html
Install PyCharm | PyCharm Documentation
2 weeks ago - Run pycharm from the bin subdirectory. ... In the main menu, go to Tools | Create Desktop Entry. The following steps are for Ubuntu 23.10. If you are using a different Linux distribution or version of Ubuntu, refer to its documentation.
JetBrains
jetbrains.com › help › pycharm › using-docstrings-to-specify-types.html
Specify types with docstrings | PyCharm Documentation
September 1, 2025 - However, it is quite possible to specify the types of parameters manually, without the debugger. Both cases are explored in the section Examples. Press Ctrl+Alt+S and go to Editor | General | Smart Keys | Python. Select the Insert type placeholders ...
JetBrains
jetbrains.com › help › pycharm › settings-tools-python-integrated-tools.html
Integrated Tools | PyCharm Documentation
January 21, 2026 - Use this page to configure requirements management file, default test runner, and documentation strings treatment.
JetBrains
jetbrains.com › help › pycharm › viewing-definition.html
Definition and type definition | PyCharm Documentation
February 27, 2026 - In PyCharm, you can see where and how symbols, such as classes, fields, methods, functions, or tags are defined in your project.
Top answer 1 of 2
2
Simply highlight the module you are interested in (either in the editor or under External Libraries folder) and press CTRL+Q.
Normally an external link do the official documentation is displayed. Sometimes even some basic description of the module is available right in the IDE.
2 of 2
1
Usually highlighting the module and pressing Ctrl+Q would work for modules/classes/objects/functions in the standard libraries. You may also try to invoke "help" in the python console, especially if what you want to retrieve is something you need to import first. For example, to get the documentation of the "Workbook", you could type help(openpyxl.Workbook) to learn the details, which simply pressing Ctrl+Q would respond No Documentation Found instead.
JetBrains
jetbrains.com › help › pycharm › using-online-resources.html
Using Online Resources | PyCharm Documentation
PyCharm Resources page contains the links to keymaps, online version of documentation and tutorials, blog,
Readthedocs
scribestools.readthedocs.io › en › latest › pycharm
PyCharm — ScribesTools 0.6.1 documentation
Just like eclipse or netbeans, PyCharm is NOT a text file editor. So one do not open a file when launching PyCharm, but on the contrary create a project at a given place; and this project (or other projects) will always be opened and used in next sessions. A PyCharm project is simply a directory with a .idea subdirectory.