From 22ef08574b5562794ae59c61ecebf8d596a9b5d3 Mon Sep 17 00:00:00 2001 From: Rich Bennett Date: Wed, 19 Jul 2017 18:05:55 -0400 Subject: [PATCH] [DOC-9] Index, sources validated & built with tox Change-Id: I5a638eba279092ada8874d09130120e9ce085b06 Signed-off-by: Rich Bennett --- LICENSE | 13 ++ docs/_static/favicon.ico | Bin 0 -> 2102 bytes docs/_static/logo_onap_2017.png | Bin 0 -> 5957 bytes docs/conf.py | 361 ++++++++++++++++++++++++++++++++++++++++ etc/requirements.txt | 8 + tox.ini | 15 ++ 6 files changed, 397 insertions(+) create mode 100644 LICENSE create mode 100755 docs/_static/favicon.ico create mode 100755 docs/_static/logo_onap_2017.png create mode 100644 docs/conf.py create mode 100644 etc/requirements.txt create mode 100644 tox.ini diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..98bd56dec --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2017 Open Network Automation Platform and contributors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, + either express or implied. See the License for the specific + language governing permissions and limitations under the License. diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100755 index 0000000000000000000000000000000000000000..cb712ebd205e6101b23c385f1e3a963963979dfa GIT binary patch literal 2102 zcmZwGy>25%48U;)2xR#!ro1P(dXP><8kJEqkHS)=)mc$9J{Wlp)_H~$1LO+H#sLS* z))gr>e-3x0EpDXWa(Bp`{Sfur@1K{_$LC)~KCzcZzsQ(i{^vtQ_=;)-w(N?TiTz{p z{qMh6ETe!#sxUN>EJ$D{7bq$WO{54CGB_xT3PT&On}`_&iV8y$VOMHGMuDQj(6~uK zLPmk2!q7zcN=wKnP*fP2WZ^a?!9N9x3PX!WONp3Kpr|mkc%vp%> zZNK^MW~}J>ICz2~Z^wgK{=~QzOb6Gz zPcX(y!~xY)J|=w2%QU;gk0>;1Xzy?>bs z-u%X9{pm~e|IT|Px#1ZP1_K>z@;j|==^1poj532;bRa{vGqB>(^xB>_oNB=7(L7TQTfK~#8N?VSmH zRMox5f0-qdeK83ELADl@N~s`V0hhM$e7w4pMXO?Ek*%VDTBU%9RRjbqvRGN_7M~(k zN}+-*V)Y?G2nYd@uw-G$zHc*=Su*qf|C1Aw%$!MPCJWT&%jc3g=iWK@&Yk~ymOBBP zH*a(;HuvR9TNI5-#q^v_=$P6te86E0o4C~F$WND8s;$Z2dnoq?~< z%J+!V`*97VoOA&&M1|p}@zMBv;ys8kG_Ejtxp^2hdNiV=qGgR|^nrS8-@Z+j{HL(6 z5ck}DFQTIxp0lW^2#1pn$&&vhA5X^2nX?cc9xiLt{N;_;(W6HXS@N9=85i*I!@omh zWTdQV9(uhV*N~C!+O;eC54Z`VMvant8WJ#X-hAh_t=kYp7SUH64hKp~O3 z{OVW3g-|zjE`P9)jIb>K_P6(A)#_EU7SPDQK4UhU$vPEb(V~|;D#s@mGjQMDUHC^v zI=(5$m$h{a9y}PQQ@+E5i4(*HvQV@Ju}c$R2r{&qaxmPsA=m(`&5mnVyf170hlPNJ zdhD3{WX;vb3opEYsHiBf1U4)z3`>?Qm8Gi>gTa9K_;_sFwjEO@PnETPDu~@~$DqN3 zaPd+G#!nb8Ya23k{}*`cObVju#Np)579LH){G_jiM{(u(=NAZ9$8Mj!LQ69Dv%|2H zWp67C6dL6gmdH}`;4mORKOf7MEtfS{59Q_M*u87F*P(exNC@6}`yE-jI$=fUP;}R> zU9!eU1z`(cR#pbBR*U!EOAvomto`;Rj5Zr0DDmf$@)kokGL3HP1N(MkYet$pvW{K5 zKgFt5uc4x%0!E`z);6DIpC5sayhmH2@grRI1jpQK*Ss!ER}Zf&T_(aMZ@dS?$FY*E zU9(o!T%8D6jfs&ZFLMyK>anr0*!1BCpa*$a&6S4N-338wA$#XTmS9q3c2YOx`hko%*$F|&i zWwhFnR$PwsydqM(Kxj2;8#C+YeX;z`pUYAWo^lYrA4NsQWQ`3)1)|sblr(HCRsJ1uKcll{cjz{nu?la!wHpI`^AkvD)y#Z%1HUzh1J&H$FO*h6gwA zg_hdZDU_sN$7_%@ZHz3{(3pZ8PdFLYrLbi6y#@Q z*j$B+KL;neZ@%>=#qm?b=Wvw=4$s+>96J29tnm&{3c@mAw^!rTcPC|ycf9%6xA5w# zuZl31H&eLBVQeIcs?T;BVR+g?TAAGP$X?a;#IT;@@Vz@ABTy}-umz|w0 zOD%)yJWVlW>SUZbnoA>;P#!}Xgt<5W>8 zIs}C%g`_F?J?wSjf`SqEZUPn_IU@Je!8dyAKemcqF3wMUIggFrqYC$IwrX^V43j1Q ziK38b)Xg`Do-0>M$}8n7@2LHfKi={;3Qvl}>-q#z=$f6CjkRm9d_J=B&nxAthE!Ho zV%Dsg;`Ov?QcYNJ-UGP=nek2`9!cF}f z<_862<@oNS7!(~m|bL+6%#JH6!EM$`>KZ+*|P@@ew`?K(|9b#lPcO+fjsS0gkAp9IXqM-qKYa~5`W=XUUd(-zdkK3U6$IG z6Uir#kwLkpB4#(6%$PIhSy`%K-u!tYDOY`t&p-Pd#YM%kbY+Q%RC_cwQkvRaBjwC# z+;x|FipZA~Gp;&$vPN({Phg96cl0K)`D z9zU77e?JCn*@8<77kK*gcNjQmAoBC_WQ_~XMwEcAwWSap04fEc)7yEDm!C|SFhPWr zDx#vJP*~(kuT9JFrx#xm1A{8Y-ZvIH7scUYxi?7Vaabr9FJ3H5S1+0sE0&|E*!^a2 zJbhY(Qju@JjfW`TV1ZQ$bA5O}3%ZJO#CC`5)S1Re1B|X zuvdx?4n{6{iCeaAMGSebe`VG6x&(&=Q?mFzd6H6D<3i)jw+&5v#>QB@oa}Ybeu^^5gyEyDhj<LLOLcHh)<6IG z305p$A#1K2=`ta&4~OtPp;l>1&lZ$o#=!%KrBI4{nVJ%26?$y|G`avJT`asjkau2bl?Ze|97M%`!A6@BkUCj(?rGoGp4Hj~f)h-0H@LUxPR!Yt} zAEke;a9toBuPq5c0Ueun)(i)=tferk*6QfA8d#kU zvj1e(tX(bUH>o@c=LVZT*d$9W%ZHmjq%cZ7p2G?Iu3fwF)RRx+$=Odex?Q+%K^ZDC zT%VkrEK9z_^1)ufm#s0G;;`@D-`p!+H>n_u5Nb-Yiz`V9$eQabYH||}y;xzaWa%xA zYT+fk6=wEOtN>Z*CO8Y|qDV1Vxi|zXp-_yy6)Rf1a?~(#um^*gt!0z39}8 z5JHNfBSpzPXGDq7>R0$96o3>Vzu1geXAms84rE?5qKcHQT`}C*{LzOZ=2y)k;8^~? zvA)faZHmu7|CboB^kn%NRuW!1-PGnuIcoXps{_c%&6TAq2M<1Xy0&iOtk(*{uDu!# z7y`A3w+Ex}Ko!c5TM=Cxh*+&bOaN55e^2nStZd<0J>n~Zk$JEZ)^pW}%BS|KgHY{b zdu}xLUWI`9i-kwaRmx1K=Yi0cCNujox^?d+OLefIW@cuhTi5Q&fjM6}e*8ElPMp|a zZA5FrtNCu~*Prq%_jzrtfsj9v1D;*Xo|l&!+;jKcV!-_1!9;nKFCK)#pSXY^7&5h} zEV2pf&q=n05=Zl8JHi9?B=9vSZVEnz6)o0GignqEN|Q}^3~tjN;D9mLhG<=&Nc8ODm2#;tp zPtNCwjEum`ipwYUizJuo{AS2y(n9(qsecO1=LQSBc{{< z6Dfj?!XH+QTEq?HUe}9Gbg&0ON4W}He-%P&c^@4gl%<8Sh+3vRrhZZ{6or)0cFBQw z6Dg!#D?FF4gd6nK80Sh25oeWSUC6PgEY*WPXGAMK7Kn2KPjj`{lkmeZn#hWhlk>lSkRBDRgKK zA)#T)?}i1EzYAVr>hH#jw^ZLHpN~(uaiede>wHbzqo&Gzlv_yCIZ-VEbfIon8n9p; zI#-8@P|A~1GzK@xvvT$ES`=w5q-a2FVIa&VyGY7?ZI97V{HBQxK%u1=JAXeGzwX^t z?(xjX_jY2>`OD;m+!ex7X~Hc(z79_g`6-5W?TAic?gL>es+|s$n5~%gX(G0KlLCEc zuu>8Fc8JDNy3YDEwxaNxV@E}Zbq}cjsJALuA8_fl`L>~_JxZL=SMZRqL3GuolZF=Yg!hif^c3D zH0}+AMTLm2TYunY?UY2sMQNdf4f$mpBm1rxwUm~d(Y-??zLGRfj6}~=CUP|uc8M?et_!LO*@uciC2H%L4yjG+hEv+ETke?3~ zYcX7>pmUo%xX3H`IP7x0&c+m^d$%4!5MAMc!KeT5G-k|rOxF0%Ll2I_i4!NpwYkD! z*te$|E}^|r3Znc*c&hsTMfV9;T59zDc~yLP0J*$)OBoyol3@P7qtKH;RnrIattI(I zTWnY}@pfdaeAsK{V5Sf11CX^>T|eJs_AG{wAOwboiigVSDQ~IytJ-Sz1@iF`q2lpA zo|J>(CAn<@uRv5iuz;_P6Ht|MG{)<%|3%rY%lD8+!dpT)m}loagNlku<#)s9KYY0P zc~ncF`E2iJ@?}GA>)i>)jZ^T{$bKj*H7P%c3O>p~F?sBnZ(%xf7B;eq4zg|$$=@K> zW~O~QuTyRtS?aPf6YjXa6K0N3Pl$Wxop^p}>VOP4N~_2ev%M!*;4U{=1mQaO2#m1EMRNwU;@1`HU0?%lhIZdO zLxzYoDlN%Z2lk6Gh-$^cGG6XFY0{&zbmb6tLZ{Us@jxPe)Uy{hZBoza89%Hy9PduY zsGEDBti<^Jm%;zr>4wH#JO|sUQxwtIp>c_a>!Ts>VhzwBI^`syVTYa0UHi2thiO4tD zBCFbW-R!j0XVFWGL>DNBJg&!ba^9y8<#VmTtl2Zg^bXf^isxrh4z+OM3*xxid#AcS zyS?=m(0P1t9N!eS(EK2W+i$;J);6TPv;y}$z6J-5r=nx5?~kPyod9J4=gr4$x89CIim(0Y0&SM1}{Ws8qeYl9i)^asV^M?FTn6KvabL z=rt#0V@8h^-ix~%ea$u6X{ROeI&R_V4BQPocI^G=_2b^ksR%u~#36O>3Ru2<6aD*i zLw0_tcs3OGPKAdC;j_2rpyJpDlzrp=0Q?X(R(2lgzqJezdJ?`PoNdw%1wYjMYhr|?C>A7PI;wU)<6MrAODH@UZ#;*q?mziSQbG z_v{rR)zzdN?V(*ejNb~v0>u699pXEPUqDJuJ|XwG6BFe=b>Y|la~Ebj_PBU@JI@(v zr=6>jfSI#qJGXrFv2s?WFYrJfC)k{)@Sqhx{@#^+`}Se#lxZk0D;J8+Kl}C zE5DYxogXFvDJdyV{y`Jf6a#Ow literal 0 HcmV?d00001 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..580cce8a8 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,361 @@ +# -*- coding: utf-8 -*- +# +# ONAP documentation build configuration file, created by +# sphinx-quickstart on Wed Jul 19 16:25:31 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.graphviz', + 'sphinx.ext.todo', + 'sphinx.ext.pngmath', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'ONAP' +copyright = u'2017, ONAP Contributors' +author = u'ONAP Contributors' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = 'test' +# The full version, including alpha/beta/rc tags. +release = 'test' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'classic' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '_static/logo_onap_2017.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '_static/favicon.ico' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'ONAPdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'ONAP.tex', u'ONAP Documentation', + u'ONAP Contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'onap', u'ONAP Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'ONAP', u'ONAP Documentation', + author, 'ONAP', 'Open Network Automation Platform', + 'Platform'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +#epub_basename = project + +# The HTML theme for the epub output. Since the default themes are not optimized +# for small screen space, using the same theme for HTML and epub output is +# usually not wise. This defaults to 'epub', a theme designed to save visual +# space. +#epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or 'en' if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +#epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +#epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +#epub_fix_images = False + +# Scale large images. +#epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#epub_show_urls = 'inline' + +# If false, no index is generated. +#epub_use_index = True diff --git a/etc/requirements.txt b/etc/requirements.txt new file mode 100644 index 000000000..8ad711f2a --- /dev/null +++ b/etc/requirements.txt @@ -0,0 +1,8 @@ +tox +Sphinx==1.3.1 +doc8 +docutils +setuptools +six +sphinxcontrib-httpdomain +sphinx_bootstrap_theme>=0.4.11 diff --git a/tox.ini b/tox.ini new file mode 100644 index 000000000..c1993d9ee --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck +skipsdist = true + +[testenv:docs] +deps = -r{toxinidir}/etc/requirements.txt +commands = + sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + echo "Generated docs available in {toxinidir}/docs/_build/html" +whitelist_externals = echo + +[testenv:docs-linkcheck] +deps = -r{toxinidir}/etc/requirements.txt +commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck \ No newline at end of file -- 2.16.6