Using Help Topics
In this section:
- Documentation structure
- Built-in documentation
This type of documentation is available for Professional edition only.
- Online documentation
This type of documentation is available for both Professional and Community editions.
PyCharm documentation has the following structure:
- Meet PyCharm
This part contains system requirements and installation information, quick start guide that helps you get a grip of PyCharm, the section First Steps with the tutorials that help you perform the most basic actions - create and run your first application.
- Migration Guides
This part is intended for the users of Vim, Emacs, or Sublime Text, who are thinking about switching to PyCharm.
- How to
Using built-in documentation
To bring up help contents, do one of the following
To find a particular piece of information
To find a keyword in the Index tab
- Click the Index tab of the help viewer.
- In the search field, type the desired keyword and press Enter. The caret rests at the first occurrence of the keyword. Every time you press Enter, the caret moves to the next occurrence of the keyword. To see the information about a keyword, select one of its sub-entries.
On the PyCharm site, find online documentation:
The online version makes it possible to find entries in the table of contents, browse documentation with the table of contents, rate topics and express your opinion. The layout of online documentation consists of:
- Table of contents pane
This pane shows the table of contents.
- Topics pane
This pane shows the topic that is currently selected in the table of contents.