Uploaded image for project: 'Policy Framework'
  1. Policy Framework
  2. POLICY-3791

sphinx-build warnings in policy parent docs

XMLWordPrintable

      Observed warnings while running sphinx build on policy/parent/docs

      A review of these warnings is needed, and those that can be resolved can be taken care of.

      These warnings are observed when run on a Centos 7 linux machine

      parent/docs# sphinx-build -b html . outdir
      Running Sphinx v4.2.0
      ...

      building [mo]: targets for 0 po files that are out of date
      building [html]: targets for 109 source files that are out of date
      updating environment: [new config] 109 added, 0 changed, 0 removed
      reading sources... [100%] xacml/xacml-tutorial-enforcement
      Copying static files for sphinx-needs datatables support...[ 44%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/ColReorder-1.4.1/css/colReorder.dataTables.min.cCopying static files for sphinx-needs datatables support...[ 70%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/FixedColumns-3.2.4/css/fixedColumns.dataTables.mCopying static files for sphinx-needs datatables support...[ 73%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/FixedColumns-3.2.4/js/dataTables.fixedColumns.miCopying static files for sphinx-needs datatables support...[ 76%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/FixedHeader-3.1.3/css/fixedHeader.dataTables.minCopying static files for sphinx-needs datatables support...[ 79%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/FixedHeader-3.1.3/js/dataTables.fixedHeader.min.Copying static files for sphinx-needs datatables support...[ 85%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/Responsive-2.2.1/css/responsive.dataTables.min.cCopying static files for sphinx-needs datatables support...[100%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/pdfmake-0.1.32/vfs_fonts.js
      Copying static files for sphinx-needs collapse support...[100%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/libs/html/sphinx_needs_collapse.js
      Copying static files for sphinx-needs custom style support...[100%] /usr/local/lib/python3.6/site-packages/sphinxcontrib/needs/css/modern/styles.css
      /root/ONAP/S3P/parent/docs/apex/APEX-MyFirstPolicyExample.rst:: WARNING: image file not readable: ../../images/logos.png
      /root/ONAP/S3P/parent/docs/apex/APEX-PCVS-Example.rst:: WARNING: image file not readable: ../../images/logos.png
      /root/ONAP/S3P/parent/docs/development/devtools/devtools.rst:318: WARNING: Title underline too short.

      Running the Pairwise Tests
      ***********************
      /root/ONAP/S3P/parent/docs/development/devtools/devtools.rst:318: WARNING: Title underline too short.

      Running the Pairwise Tests
      ***********************
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:274: WARNING: image file not readable: gui/images/CreateFolder.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:275: WARNING: image file not readable: gui/images/ClassPathRunProperty.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:276: WARNING: image file not readable: gui/images/ClassPathSetting.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:277: WARNING: image file not readable: gui/images/ImportPostmanJson.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:278: WARNING: image file not readable: gui/images/PapParameter.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:279: WARNING: image file not readable: gui/images/PapInputParameter.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:280: WARNING: image file not readable: gui/images/FetchPdpLists.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:281: WARNING: image file not readable: gui/images/NoEngineWorker.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:282: WARNING: image file not readable: gui/images/XACMLstatistics.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:283: WARNING: image file not readable: gui/images/PDPstatistics.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:284: WARNING: image file not readable: gui/images/UpdateStatistics.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:274: WARNING: image file not readable: gui/images/CreateFolder.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:275: WARNING: image file not readable: gui/images/ClassPathRunProperty.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:276: WARNING: image file not readable: gui/images/ClassPathSetting.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:277: WARNING: image file not readable: gui/images/ImportPostmanJson.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:278: WARNING: image file not readable: gui/images/PapParameter.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:279: WARNING: image file not readable: gui/images/PapInputParameter.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:280: WARNING: image file not readable: gui/images/FetchPdpLists.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:281: WARNING: image file not readable: gui/images/NoEngineWorker.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:282: WARNING: image file not readable: gui/images/XACMLstatistics.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:283: WARNING: image file not readable: gui/images/PDPstatistics.png
      /root/ONAP/S3P/parent/docs/gui/Monitoring-GUI-Demo-Guide.rst:284: WARNING: image file not readable: gui/images/UpdateStatistics.png
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/dir/subdir/invalid.rst:2: WARNING: Title underline too short.

      Hello
      ====
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid.rst:2: WARNING: Title underline too short.

      Hello
      ====
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_line_mismatch.rst:1: WARNING: Title overline & underline mismatch.

      =====
      b
      ====
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_link.rst:: WARNING: Anonymous hyperlink mismatch: 1 references but 0 targets.
      See "backrefs" attribute for IDs.
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_target.rst:1: WARNING: Unknown target name: "fork me on github <https://github.com/evvers/git-pre-commit-hook".
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/second_short_heading.rst:6: WARNING: Title underline too short.

      some more
      ^^^^^^^^
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/second_short_heading.rst:6: WARNING: Title underline too short.

      some more
      ^^^^^^^^
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst:3: WARNING: Error in "currentmodule" directive:
      maximum 1 argument(s) allowed, 3 supplied.

      .. currentmodule:: {{ module }}
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst:3: WARNING: Error in "currentmodule" directive:
      maximum 1 argument(s) allowed, 3 supplied.

      .. currentmodule:: {{ module }}
      WARNING: invalid signature for autoclass ('{{ objname }}')
      WARNING: don't know which module to import for autodocumenting '{{ objname }}' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
      WARNING: invalid signature for automodule ('{{ fullname }}')
      WARNING: don't know which module to import for autodocumenting '{{ fullname }}' (try placing a "module" or "currentmodule" directive in the document, or giving an explicit module name)
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst:53: WARNING: Unknown directive type "autosummary".

      .. autosummary::
      :toctree:
      :recursive:
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst:56: WARNING: Explicit markup ends without a blank line; unexpected unindent.
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst:58: WARNING: Definition list ends without a blank line; unexpected unindent.
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinxcontrib/needs/directives/needimport_template.rst:18: WARNING: Explicit markup ends without a blank line; unexpected unindent.
      looking for now-outdated files... none found
      pickling environment... done
      checking consistency... /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/Jinja2-3.0.2.dist-info/LICENSE.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/alabaster-0.7.12.dist-info/DESCRIPTION.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/cycler-0.10.0.dist-info/DESCRIPTION.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/imagesize-1.2.0.dist-info/LICENSE.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/pbr/tests/testpackage/data_files/c.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/pbr/tests/testpackage/doc/source/index.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/dir/subdir/invalid.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/dir/valid.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_line_mismatch.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_link.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/invalid_target.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/second_short_heading.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/utf8.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/restructuredtext_lint/test/test_files/valid.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinxcontrib/needs/directives/needimport_template.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib/python3.6/site-packages/sphinxcontrib_swaggerdoc-0.1.7.dist-info/DESCRIPTION.rst: WARNING: document isn't included in any toctree
      /root/ONAP/S3P/parent/docs/onap_docs/lib64/python3.6/site-packages/MarkupSafe-2.0.1.dist-info/LICENSE.rst: WARNING: document isn't included in any toctree
      done
      preparing documents... done
      pip install -r etc/requirements.txtwriting output... [ 62%] drools/feature_statemgmt writing output... [100%] xacml/xacml-tutorial-enforcement
      generating indices... genindex done
      writing additional pages... search done
      copying images... [100%] pap/images/PolicyImplPDPSubGroup.svg
      copying downloadable files... [100%] xacml/swagger.json
      copying static files... done
      copying extra files... done
      dumping search index in English (code: en)... done
      dumping object inventory... done
      build succeeded, 64 warnings.

      The HTML pages are in outdir.

      Checking sphinx-needs warnings

            liamfallon liamfallon
            sirisha_manchikanti sirisha_manchikanti
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: