Uploaded image for project: 'ONAP Operations Manager'
  1. ONAP Operations Manager
  2. OOM-2646

Remove wanings during Documentation building

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Medium Medium
    • Guilin Release
    • None
    • None
    • None

      During documentation generation,

      some Warnings are detected:

      /w/workspace/rtdv3-global-verify-master/docs/oom_hardcoded_certificates.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-amsterdam.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-beijing.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-casablanca.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-dublin.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-elalto.rst: WARNING: document isn't included in any toctree
      /w/workspace/rtdv3-global-verify-master/docs/release-notes-frankfurt.rst: WARNING: document isn't included in any toctree

      Some links are not correct or broken:

      oom_cloud_setup_guide.rst

      (line 50) broken https://nexus.onap.org/#welcome - Ancre 'welcome' non trouvée

      (line 1134) broken http://onap.readthedocs.io/en/latest/submodules/msb/apigateway.git/docs/platform/installation.html - 404 Client Error: Not Found for url: https://docs.onap.org/en/latest/submodules/msb/apigateway.git/docs/platform/installation.html

      oom_user_guide.rst

      (line 484) broken http:/ - Invalid URL 'http:/': No schema supplied. Perhaps you meant http://http:/?
      (line 415) broken https://portal.api.simpledemo.onap.org:30225/ONAPPORTAL/login.htm - HTTPSConnectionPool(host='portal.api.simpledemo.onap.org', port=30225): Max retries exceeded with url: /ONAPPORTAL/login.htm (Caused by ProxyError('Cannot connect to proxy.', OSError('Tunnel connection failed: 403 Forbidden')))
      (line 373) broken https://kubernetes.io/docs/concepts/services-networking/service/#type-loadbalancer - Ancre 'type-loadbalancer' non trouvée

       

      Use the 2 commands to check locally

      sphinx-build -b linkcheck . _build/linkcheck

      sphinx-build -b html . _build

       

            eric.debeau eric.debeau
            eric.debeau eric.debeau
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: