Advanced

How to document Python code with Sphinx

Posted by bob on
Opensource.com; By Moshe Zadka 		Mail this story
Print this story

Python code can include documentation right inside its source code. The default way of doing so relies on docstrings, which are defined in a triple quote format. While the value of documentation is well... documented, it seems all too common to not document code sufficiently. Let's walk through a scenario on the power of great documentation.

Full Story

  Nav
» Read more about: Story Type: Tutorial; Groups: Developer, Python

» Get new stories by e-mail: nightly or as they are published

« Return to the newswire homepage

  Related stories
» More like this

This topic does not have any threads posted yet!

You cannot post until you login.