Generate Sphinx Friendly Docstrings For Python Functions In Emacs!

2 min read

Today, I went to Django REST Framework Workshop. After the workshop is completed,  and we were discussing about Emacs, Krace showed this cool plugin sphinx-doc, it inserts docstring skeleton for Python functions/methods as per the requirement of the Sphinx documentation generator.


Installation:

To install it from MELPA, run "M-x package-list-packages", search for "sphinx-doc" , mark it with i and press x to install.

Configuration:

Add these lines to Your emacs config to enable sphinx-doc-mode.
(add-hook 'python-mode-hook (lambda ()
                  (require 'sphinx-doc)
                  (sphinx-doc-mode t)))
If you document your code(infact you should), this plugin saves quite a few strokes! 

Chillar Anand
A blog about python, careers & life.
To contact me, send a message here.