PyCharm 1.5 Early Access: ultimate docs support + Django templates debugging

Dmitry Jemerov

Today we’re happy to announce the immediate availability of the first Early Access Preview build of PyCharm 1.5, the next major release of PyCharm.

The big theme of this release is a comprehensive documentation support. PyCharm now understands not only your code, but also the documentation surrounding it. The big theme boils down into a number of specific features described below:

Another big addition in this release is Django templates debugging. This deserves a separate blog post, so stay tuned for announcements in the coming days (meanwhile, a screenshot).
PyCharm: Django template debugger

External Documentation

To open the documentation Web site for an element under the caret in your Web browser, press Shift-F1 (View | External Documentation). The structure of the documentation sites for the Python standard library, Django and Google App Engine is known to PyCharm by default; for other libraries, you can define the URL to be opened for a particular element yourself (and a number of libraries are preconfigured by default).

Rendered Docstrings

The Quick Documentation Popup in PyCharm now renders the Epydoc or reStructuredText markup in your documentation strings, instead of displaying the docstrings as raw text.

Syntax Highlighting and Completion in Docstrings

PyCharm now highlights the markup in Epydoc and reStructuredText docstrings and provides code completion for tags and tag parameters. Also, it checks that the names of the parameters match between the docstrings and the code, and updates the docstring automatically when a parameter is renamed.

Docstring Stub Generation

PyCharm can now automatically generate a docstring stub for a method, according to the format specified in Settings | Python Integrated Tools (either Epydoc or reStructuredText). To generate the stub, press Alt-Enter on the method name, or simply type the opening triple quotes of a docstring and press Enter.

reStructuredText support

reStructuredText is now a fully supported file type in PyCharm, with syntax highlighting and some code completion support.

PyCharm 1.5 release is planned around the end of May and will be a free update for everyone with a license.
Meanwhile, you are welcome to download PyCharm 1.5 EAP from the EAP page and we are looking forward to your feedback.

Comments below can no longer be edited.

16 Responses to PyCharm 1.5 Early Access: ultimate docs support + Django templates debugging

  1. jon says:

    May 4, 2011

    The Django template debugging is pretty exciting. So many times I have wanted to see what was going on in my template. This will save me many headaches.

    The doc support is pretty cool too overall sounds like a great update.

  2. Adam j Wolf says:

    May 4, 2011

    PyCharm keeps getting better. Your integration with Google AppEngine is wonderful. I am not missing visual studio at all.

    Thanks JetBrains

  3. Piotr D. says:

    May 4, 2011

    Keep up the good work!

  4. Eka says:

    May 4, 2011

    From 1.2.1 to 1.5? Am I missing something?

  5. Robert says:

    May 4, 2011

    They are probably planning some “big” additions to justify the jump.

  6. Dan Ostrowski says:

    May 4, 2011

    These features look great! The template debugging is especially exciting. Unfortunately, out of the box the new doc stuff is not working for me, maybe I’ll file a ticket.

  7. vj says:

    May 5, 2011


    I installed the EAP on OS x.

    I am not able to get the Python docs to work (using Shift F1).


  8. Yury V. Zaytsev says:

    May 6, 2011

    So there is no list of closed YouTrack tickets for this release on JIRA?

    NumPy & SciPy documentation right inside PyCharm. This alone sounds delightful. Doc stub auto-generation — miam-miam-miam.

  9. NA says:

    May 6, 2011

    Google, “Pycharm slow”. Then tell me you should keep adding more functionality as you keep losing customers because it cannot perform up to par on almost every laptop in use today.

    Features mean nothing if the IDE is painfully slow.

  10. yole says:

    May 6, 2011

    What was under the caret when you tried to invoke the external documentation that didn’t work?

    There’s really no reason to hide behind anonymity when complaining about PyCharm performance. We would be much more happy to hear specific information and details.

  11. Robert says:

    May 6, 2011

    Funny, I do not find PyCharm to be “slow”. It isn’t as fast as Vim but I don’t expect it to be for what it gives in return.

  12. Some cool new features in PyCharm 1.5 (EAP) « rawpackets says:

    May 7, 2011

    […] Read more and see some screenshots here. […]

  13. Vj says:

    May 9, 2011

    Hi Yole,

    By external documentation this is what I am assuming / expecting.

    If I position the cursor at a python keyword like “import” or a core python library , like for example re (regular exp), then I want to see the Python docs for “re”.

    So I positioned the cursor over “import” and pressed the keyboard shortcut for External documentation .

    Am i off here ?

    Also is this the right place to ask a question about debugging (i.e. how best to use the debugger to debug a django-application error)?

    thanks for your response.


  14. yole says:

    May 9, 2011

    The external documentation feature works for functions and classes, not for keywords. We assume that users of PyCharm are familiar with Python keywords.

  15. traff says:

    May 11, 2011

    Hi Vj,
    currently there is no special handling of django template rendering errors in the debugger, but we are working on it. Maybe Python Exception breakpoints will suit your needs now? Your suggestions about how to improve django errors in PyCharm are always welcome.

  16. Brad Miller says:

    May 12, 2011

    Love to see the support for reStructuredText.

    Will there be some preview options in the future? I would be great to be able to pull up the current file in a browser window after rendering it to html for example… Or will there be some way to create a run configuration that will at least run on the current rst file? (maybe this is already possible and I just don’t know the right way to configure it)



Subscribe for updates