On Tue, Apr 19, 2016 at 11:42 AM, Peter Funk <issues@roundup-tracker.org> wrote:
>
> I propose that we should either include these documents in index.txt
> or we should silence these warnings from Sphinx by adding them to
> the exclude_patterns list in the doc/conf.py file for Sphinx.

We can always silence the warnings and comment out tests, but that
drops the quality of code (or documentation in this case).

Those warnings is an indication of problems with our release
engineering process and with content.

> To be more precise: My proposal is:
>
> announcement.txt   : ignore in conf.py exclude_patterns
> debugging.txt      : add to index
> implementation.txt : add to index
> mysql.txt          : add to index
> postgresql.txt     : add to index
> overview.txt       : add to index
> security.txt       : add to index

Current top level is already too big, so I would think about restructuring
documentation.

> whatsnew-0.7.txt   : ignore in conf.py exclude_patterns
> whatsnew-0.8.txt   : ignore in conf.py exclude_patterns

Those human readable release summaries is a good start, but now
look like garbage. In a perfect world these would be blog/news items
with links to detailed CHANGES and UPGRADE instructions.
-- 
anatoly t.