Roundup Tracker - Issues

Message5539

Author pefu
Recipients pefu
Date 2016-04-19.08:42:17
Message-id <1461055338.45.0.910362850098.issue2550907@psf.upfronthosting.co.za>
In-reply-to
While running the command python setup.py build_doc I saw several
warnings about documents not included in the table of contents:

checking consistency... /home/pf/roundup-copy/doc/announcement.txt::
WARNING: document isn't included in any toctree
/home/pf/roundup-copy/doc/debugging.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/implementation.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/mysql.txt:: WARNING: document isn't included
in any toctree
/home/pf/roundup-copy/doc/overview.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/postgresql.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/security.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/whatsnew-0.7.txt:: WARNING: document isn't
included in any toctree
/home/pf/roundup-copy/doc/whatsnew-0.8.txt:: WARNING: document isn't
included in any toctree
done
...
build succeeded, 9 warnings.

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.

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
whatsnew-0.7.txt   : ignore in conf.py exclude_patterns
whatsnew-0.8.txt   : ignore in conf.py exclude_patterns

If no one objects, I will submit a patch doing this soon.
History
Date User Action Args
2016-04-19 08:42:18pefusetrecipients: + pefu
2016-04-19 08:42:18pefusetmessageid: <1461055338.45.0.910362850098.issue2550907@psf.upfronthosting.co.za>
2016-04-19 08:42:18pefulinkissue2550907 messages
2016-04-19 08:42:17pefucreate