setup.py: documentation

Date: January 25th 2016
Last updated: January 25th 2016

Where is the best place to put documentation for distribution?

By documentation I mean background notes, implementation details or notes referring to scripts. All the stuff that would make the README file convoluted.

A docs directory can be added to the root position. All file extensions are then added to MANIFEST.in.

File structure (adjusted for clarity):

Project
    |
    ├── CHANGES.txt # version log
    ├── MANIFEST.in 
    ├── README.md # main documentation
    ├── setup.py # metadata
    |
    ├── bin
    │   └── script1.py 
    |
    ├── docs
    |   ├── notes_s1.txt # implementation notes for script in bin
    │   └── background.md # historical context of this project
    |
    └── module
        ├── __init__.py
        └── module.py

Manifest.in:

include *.txt
include *.md
recursive-include docs *.txt   # finds notes_s1.txt
recursive-include docs *.md    # finds background.md
recursive-include bin *.py

Include scripts referred to in documentation:

# Update setup.py
scripts = ['bin/script1.py'],