Based off the DocBlockr project, This extension provides the similar funtionality but for python docstrings. The default formatter for this plugin is designed around PEP-257 compliance but with more verbosity: Added variable types, listing class extensions, and listing decorators. The main goal of this project is to help developer provide better documentation by giving easy and consistent formatting.

Installation

Manually Download the release and put it in your installed packages directory yourself

1. Go to the Latest Release and download the python-docblockr.sublime-package file.
2. Move this file to your Installed Packages directory. (Preferences > Browse Packages... and go up one directory to see Installed Packages)
3. If you are updating your existing install, a restart of Sublime Text will be in order.

Usage

There isn't a command pallete command to start this plugin, it is triggerg by hitting enter or tab after opening a docstring (""") at the module, class, or function level. If you wanted to simply put a new line after opening a docstring and not trigger the formatter, just hold ctrl and press enter.

Default and User Settings

You can configure which docstring format to use by updating your user settings for this package (Preferences > Package Settings > Python DocBlockr > Settings).

Project Settings

You can also override your user settings on a per project basis by editing your project file. Any setting will be available for overriding here.

{
  "PythonDocblockr": {
    "formatter": "sphinx"
  },
  "folders": [
    // ...
  ]
}

Supported Docstring Styles

• Docblockr (PEP0257 with types)
• PEP0257
• Google
• Numpy
• Sphinx (reST)

Known Issues

• Only detects closed docstring if it is on a line of the same indentation, and has no text in front of it. Single Line docstrings are converted to block