Remove warnings in sphinx build logs
mgielda opened this issue · comments
As in title - we need to get rid of those of course, they were ignored temporarily to get this off the ground but now we need to improve.
Can you paste the warnings in this github issue?
The latest log with the warnings:
unning Sphinx v2.2.0
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 5 changed, 0 removed
reading sources... [100%] vtr-verilog-to-routing/doc/src/dev/index
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:20: WARNING: toctree glob pattern 'fuzzers/*clb*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:29: WARNING: toctree glob pattern 'fuzzers/*bram*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:38: WARNING: toctree glob pattern 'fuzzers/*iob*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:47: WARNING: toctree glob pattern 'fuzzers/*clk*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:47: WARNING: toctree glob pattern 'fuzzers/*cmt*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:57: WARNING: toctree glob pattern 'fuzzers/*int*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:57: WARNING: toctree glob pattern 'fuzzers/*pip*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:67: WARNING: toctree glob pattern 'fuzzers/*xadc' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/tilegrid'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/tileconn'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/ordered_wires'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/get_counts'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/dump_all'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:89: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/fuzzers/timing'
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:98: WARNING: toctree glob pattern 'fuzzers/*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/db_dev_process/parts.rst:109: WARNING: toctree glob pattern 'minitests/*' didn't match any documents
github-symbiflow-docs/source/prjxray/docs/index.rst:26: WARNING: toctree contains reference to nonexisting document 'prjxray/docs/db_dev_process/readme'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:20: WARNING: toctree glob pattern 'fuzzers/*clb*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:29: WARNING: toctree glob pattern 'fuzzers/*bram*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:38: WARNING: toctree glob pattern 'fuzzers/*iob*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:47: WARNING: toctree glob pattern 'fuzzers/*clk*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:47: WARNING: toctree glob pattern 'fuzzers/*cmt*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:57: WARNING: toctree glob pattern 'fuzzers/*int*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:57: WARNING: toctree glob pattern 'fuzzers/*pip*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:67: WARNING: toctree glob pattern 'fuzzers/*xadc' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/tilegrid'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/tileconn'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/ordered_wires'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/get_counts'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:76: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/dump_all'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:89: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/fuzzers/timing'
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:98: WARNING: toctree glob pattern 'fuzzers/*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/parts.rst:109: WARNING: toctree glob pattern 'minitests/*' didn't match any documents
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/index.rst:28: WARNING: toctree contains reference to nonexisting document 'symbiflow-arch-defs/third_party/prjxray/docs/db_dev_process/readme'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/building'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/contributing'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/developing'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/tutorial'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/support'
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/dev/index.rst:6: WARNING: toctree contains reference to nonexisting document 'vtr-verilog-to-routing/doc/src/dev/license'
looking for now-outdated files... none found
pickling environment... done
checking consistency... github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/lib/python3.7/email/architecture.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/lib/python3.7/site-packages/cryptography-2.7.dist-info/AUTHORS.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/lib/python3.7/site-packages/ply-3.11-py3.7.egg/EGG-INFO/DESCRIPTION.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/lib/python3.7/site-packages/python_utils-2.3.0.dist-info/DESCRIPTION.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/pkgs/cryptography-2.7-py37h1ba5d50_0/lib/python3.7/site-packages/cryptography-2.7.dist-info/AUTHORS.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/pkgs/gettext-0.19.8.1-hc5be6a0_1002/share/doc/gettext/examples/hello-pascal/hello.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/pkgs/python-3.7.3-h0371630_0/lib/python3.7/email/architecture.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/build/env/conda/share/doc/gettext/examples/hello-pascal/hello.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/fasm/docs/specification.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/docs/index.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/prjxray/third_party/fasm/docs/specification.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/symbiflow-arch-defs/third_party/symbiyosys/docs/source/index.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/ODIN_II/README.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/dev/coverity_model/README.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/doc/src/index.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/vtr_flow/arch/titan/README.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/vtr_flow/benchmarks/titan_blif/README.rst: WARNING: document isn't included in any toctree
github-symbiflow-docs/source/vtr-verilog-to-routing/vtr_flow/benchmarks/titan_other_blif/README.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
writing output... [100%] vtr-verilog-to-routing/doc/src/index
generating indices... genindexdone
writing additional pages... search/usr/local/lib/python3.7/site-packages/sphinx_symbiflow_theme/search.html:20: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a <script> tag directly in your theme instead.
{{ super() }}
done
copying downloadable files... [100%] vtr-verilog-to-routing/libs/EXTERNAL/libblifparse/doc/blif.pdf
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 58 warnings.
They are spread across several repositories.
FYI - @acomodi
Since the documentation was updated to use intersphinx, instead of submoduling other repos, I believe this issue can be closed.