Re: enhance release experience

> 
> On 19. nov. 2014, at 12.07, Jens W. Klein <jens-/[email protected]> wrote:
> 
> [snip]
> 
> Next I see sometimes a mix between README.rst and documentation. Having 
> a docs directory is fine, as long as theres documentation in. I dont see 
> the point to put the magic triple of README, CHANGES and LICENCE file in 
> there. Having those in the root on your fingertips does not only save 
> one click, since the amount of files on root level is small, it also 
> doent not reduce the package overview.
> 
> So long I propose to keep things simple. Even in cases where /docs 
> contains real (sphinx) configuration I'am the opinion that a 
> documentation title page has a different target group than a package 
> README. So DRY does not apply.

I'm +1 for setting a policy to have README, CHANGES & LICENCE in root.
I was against this in the past but I most people I talked to believe this is a
good approach so let's do it.

However, I still believe that we should include all these three files into Sphinx
docs. It just makes so much sense! README has compact description about 
the package. What better way to start (developer) documentation in Sphinx than
with a compact description of what this package is all about. Also, it's helpful
to be able to see the CHANGES immediately in the "Contribute" section of
Sphinx docs.


z.


------------------------------------------------------------------------------
Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
from Actuate! Instantly Supercharge Your Business Reports and Dashboards
with Interactivity, Sharing, Native Excel Exports, App Integration & more
Get technology previously reserved for billion-dollar corporations, FREE
http://pubads.g.doubleclick.net/gampad/clk?id=157005751&iu=/4140/ostg.clktrk