Documentation

Install sphinx (if not already done)

        
            sudo apt-get install python-sphinx
        
    

Set up sphinx in your project

Create a docs dir (in your project root dir):

        
            mkdir docs && cd docs
        
    

Create docs config;

        
            
        sphinx-quickstart
        # Root path: .
        # Separate source and build directories: n
        # Create Makefile: y
        # For other yes/no questions, just type Enter key
        # For remaining questions, just fill it in
    
        
    

Add the following to your .gitignore file:

        
            
        # Documentation builds
        /docs/Makefile
        /docs/conf.py
        /docs/_build
    
        
    

Usage

Write whatever you need in .rst format/files.

To generate HTML files from your .rst files:

        
            make html
        
    

And your HTML files will be located in: docs/_build/html/