Where should I store docs in my project?
Diez B. Roggisch
deets at nospam.web.de
Wed Jun 10 05:30:00 EDT 2009
Matthew Wilson wrote:
> 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:
> __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
I'd put the docs-folder one the root-level, besides the setup.py
More information about the Python-list