ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Doc​Blockr_Python

by thep0y ST4

Sublime Text DocBlockr for python. Simplifies writing docstring comments in Python.

Labels python, docstring, automatic, formatter, generator, auto-complete, snippets

Details

Installs

  • Total 52K
  • Win 33K
  • Mac 9K
  • Linux 9K
Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11 Mar 10 Mar 9 Mar 8 Mar 7 Mar 6 Mar 5 Mar 4 Mar 3 Mar 2 Mar 1 Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8
Windows 1 2 0 1 0 1 1 2 0 0 2 2 3 2 4 0 0 1 0 0 2 1 1 1 1 2 1 3 1 0 1 4 0 1 0 0 1 4 1 1 1 0 1 1 1 1
Mac 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0 0 1 1 0 1 0 0 1 0 0 1 0 0 0 1 0
Linux 0 0 0 0 0 0 0 0 0 0 1 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 2 0 0 1 1 0 0 0 0 1 0 1 0 0 0 0 1 1 2 0

Readme

Source
raw.​githubusercontent.​com

DocBlockr for Python

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

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