Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Using Sphinx to generate test html

  • Once rst updates are made you can generate sample html using sphinx:

Code Block
sphinx-build -b html /home/myhome/appc/docs /home/myhome/test
  • Sample output of html generator:

    Code Block
    Running Sphinx v1.5.3
    
    /usr/local/lib/python2.7/dist-packages/sphinx/util/requests.py:58:
    UserWarning:
    Some links may return broken results due to being unable to check the Server
    Name Indication (SNI) in the returned SSL cert against the hostname in the url
    requested. Recommended to install requests-2.4.1+.
    
    'Some links may return broken results due to being unable to '
    
    loading pickled environment... done
    
    building [mo]: targets for 0 po files that are out of date
    
    building [html]: targets for 1 source files that are out of date
    
    updating environment: 0 added, 1 changed, 0 removed
    
    reading sources... [100%] APPC CDT Guide/APPC CDT Guide
    
    looking for now-outdated files... none found
    
    pickling environment... done
    
    checking consistency... /home/scottseabolt/appc/docs/release-notes.rst::
    WARNING: document isn't included in any toctree
    done
    
    preparing documents... done
    
    writing output... [100%] index
    
    generating indices... genindex
    
    writing additional pages... search
    
    copying images... [100%] APPC CDT Guide/media/image34.png
    
    copying downloadable files... [100%] APPC CDT Guide/Generic 1802 User Input Spreadsheet v.02.xlsx
    
    copying static files... WARNING: html_static_path entry u'/home/scottseabolt/appc/docs/_static'
    does not exist
    
    WARNING: logo file '_static/logo_onap_2017.png' does not exist
    
    WARNING: favicon file '_static/favicon.ico' does not exist
    done
    
    copying extra files... done
    
    dumping search index in English (code: en) ...
    done
    
    dumping object inventory... done
    
    build succeeded, 4 warnings.