After looking as the warnings in OCDS sphinx build I conclude that all the warnings make sense and should try and be addressed. This means at some point we could say that there should be no warnings for a successful build and they all should be addressed.
The only warning that still needs work is working out is how to exclude the 404 page from the warning about it not being in the table of contents.
Warnings in OCDS dev branch as of 16/11/17.
ERROR: Insufficient data supplied (1 row(s)); no data remaining for table body, required by "extensiontable" directive.
.. extensiontable::
:extension: lots
:definitions: Lots
Easy to fix and a real error where using a definition (Lots) that does not exist.
WARNING: image file not readable: implementation/../../../../assets/levels_en.png
Easy to fix the file is not there.
standard/docs/en/404.md:: WARNING: document isn't included in any toctree
standard/docs/en/implementation/worked_examples.md:: WARNING: document isn't included in any toctree
It makes sense why the 404.md is not in the toc tree. Worked_examples.md looks unfinished and probably should be deleted.
WARNING: inconsistent term references in translated message
There are loads of these warnings. This is fixed by making sure the doc_ref tranform in recommonmark is run after the i18n sphinx tranform. It will also be fixed by the latest verson of recommonmark using the all role.
WARNING: Inline literal start-string without end-string.
This is a real issue only with the french tranlations as in the translation have added some literal backticks where there should not be any. i.e in "initiationType"
Summary
After looking as the warnings in OCDS sphinx build I conclude that all the warnings make sense and should try and be addressed. This means at some point we could say that there should be no warnings for a successful build and they all should be addressed. The only warning that still needs work is working out is how to exclude the 404 page from the warning about it not being in the table of contents.
Warnings in OCDS dev branch as of 16/11/17.
Easy to fix and a real error where using a definition (Lots) that does not exist.
Easy to fix the file is not there.
It makes sense why the 404.md is not in the toc tree. Worked_examples.md looks unfinished and probably should be deleted.
There are loads of these warnings. This is fixed by making sure the doc_ref tranform in recommonmark is run after the i18n sphinx tranform. It will also be fixed by the latest verson of recommonmark using the all role.
This is a real issue only with the french tranlations as in the translation have added some literal backticks where there should not be any. i.e in "
initiationType"