Where should I store docs in my project?

[Matthew Wilson]

I used paster to create a project named pitz. I'm writing a bunch of
user documentation. Where should I put it?

The project looks a little like this:

/home/matt/projects/pitz
setup.py
pitz/
__init__.py # has my project code
docs/ # has my reST files
tests # has some tests

Is there a convention for where to put the docs folder?

 

[Diez B. Roggisch]

I used paster to create a project named pitz. I'm writing a bunch of
user documentation. Where should I put it?

The project looks a little like this:

/home/matt/projects/pitz
setup.py
pitz/
__init__.py # has my project code
docs/ # has my reST files
tests # has some tests

Is there a convention for where to put the docs folder?

I wouldn't put it into the pitz-package - because then these get
(potentially) installed into site-packages - where no one is going to see
them anyway.

I'd put the docs-folder one the root-level, besides the setup.py

Diez