ldong

# Python Generate Docs

## List of Doc Generators

|Name|List|
|----|----|
|[mkdocs](http://www.mkdocs.org)| Needs to use markdown files to generate documentations|
|[pdoc](https://github.com/BurntSushi/pdoc)| Generate to HTML/Plain Text from modules and py files|
|[sphinx](http://sphinx-doc.org/)| Generate from py files into rST and converts to HTMLs|

ldong

Python import

Notation

Python import uses Package(dot notation)

Ways of importing

1. import X, is preferred
2. from X import *

ldong

Fast track

Day 3 Agenda

Speaker: Rick Copeland

Date: Tue Jul 15 19:02:58 EDT 2014

Generators

ldong

#!/usr/bin/env python

"""Simple HTTP Server With Upload.

This module builds on BaseHTTPServer by implementing the standard GET
and HEAD requests in a fairly straightforward manner.

"""

ldong

Sphinx Notes

What is sphinx

Sphinx is used to document api-docs, the python docs also uses this.

Starter

Sphinx uses rst to write documents, but I've used markdown to write docs for a

ldong

JavaScript frameworks

Node

These frameworks/libraries are node plugins

A list of libraries

• Chai -- BDD/TDD assertion library

ldong

JavaScript

Lets talk about Deferred and Promise in JavaScript

Deferred

What is a Deferred in JavaScript?

Deferred has 2 methods:

1. resolve

ldong

Lets talk about tools

Author: Lin Dong

Date: July 22, 2014

Tools

Tools I use for my daily life:

ldong

Python Libs

Common libraries

Standard libs

argparse

ConfigParser

ldong

How to debug python

Use iPython

import sys

class ExceptionHook:
    instance = None