summaryrefslogtreecommitdiffstats
path: root/etc
AgeCommit message (Collapse)AuthorFilesLines
2019-05-15First commit to dublin branchRich Bennett1-1/+2
Add default branch to .gitreview Switch sphinx theme to bootstrap with bootswatch lumen style Reuse OPENDAYLIGHT/OPNFV side navbar templates Remove unused options in conf.py and add the License text Begin to use the lfit/releng global doc project template Add TODO for guidelines on use of the new theme Update submodule references for contributing repositories that already have a dublin branch Change-Id: I60c26a25bd15b90ab4878b0635ebd9b9d8712a0d Issue-ID: DOC-467 Signed-off-by: Rich Bennett <rb2745@att.com>
2019-02-22Fix build timeout & upgrade sphinxRich Bennett1-1/+1
Back out collapse_navigation change, it increases build time 6x Upgrade sphinx release 1.8.4 Change-Id: Ib2a4e85712416c96a8096753f0f119d73b7d6c90 Issue-ID: DOC-406 Signed-off-by: Rich Bennett <rb2745@att.com>
2019-02-15Whitening the search backgroundGergely Csatari1-1/+1
The 0.4.3 version of sphinx_rtd_theme supports the possiblity to change background of the search area. This change modifies the background to white to make it inline with the ONAP logo. Issue-ID: DOC-402 Change-Id: I5156cf0ed146e12d9dbd2b5685a7ff563a88f6a2 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
2018-11-02Add submodule information summary when running toxRich Bennett1-1/+1
Add summary and advance sphinx requirement to latest stable release Change-Id: I4aae9c9e54bed7943beba24d9cb57f1338974ddf Issue-ID: DOC-332 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-07-12Add support for sphinx NEEDS DirectiveRich Bennett1-0/+1
Add configuration, pip requirements, and conventiions for use Change-Id: Ia065b7f72fc5aa16b4010b0100dc70e2f0a42b8c Issue-ID: DOC-285 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-05-08Add spellcheck and linkcheck exceptionsRich Bennett1-0/+1
Add frequently used acronyms or words used in ONAP documentation Add representative domain or IP addresses are not expected to pass a linkcheck Add sphinx extension for drawing network diagrams Change-Id: Iea76f4a279da755fdd5d87e3b723ef261b9d19cd Issue-ID: DOC-262 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-04-11Clean-up using onap sectionRich Bennett1-1/+1
Migrate top level structure from wiki Eliminate duplicated subsections Move to current stable release of Sphinx (1.6.7) Change-Id: I2999962c306d69756161cb90993694877265b476 Issue-ID: DOC-259 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-26Remove http domain directiveRich Bennett1-1/+0
Only used as an example of API documentation Remove to allowing parallel reads during verify and build Change-Id: Ib0549d12d80f986dba41c70706478c1fddfd9ef3 Issue-ID: DOC-142 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-10Improve templates and add references in guidesRich Bennett1-0/+1
See description of DOC-101 Added multipple conf.py files to test themes and multiple versions Created initial structure for references in developer architecture guide and release notes Change-Id: I7affcd1cb0258bef7cebe357a938080abe419693 Issue-ID: DOC-101 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-29Allow multiple sphinx-build threads on verify jobRich Bennett1-1/+0
Add branch and ignore value on all submodules Remove duplicate httpdomain requirement Issue-ID: DOC-93 Change-Id: I129e288b2d6825ef21efe48acfb5df2c2ffc8bdb Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-18Remove linkcheck and add API examplesRich Bennett1-0/+3
Part 1 of moviing linkcheck from verify to a CSIT job Added API examples and extensions used to document APIs Change-Id: I5dd536c50930b09bb129e95a9767c97f09c0604b Issue-ID: DOC-82 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-24Update How To Guide & Git submodulesRich Bennett1-0/+1
vnfrqts/requirements master advanced beyond submodule reference in doc before verify job available updated git reference to current level Improvements in the how to guide describing submodule integration Updated sphinx configuration to support sequence diagrams Temporary exclusion filter reduced for seed documents with severe errors Issue-Id: VNFRQTS-76 Change-Id: I3928a3d1e55a0731125e07186d8041b1614c3c8d Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-08[DOC-24] Revert to Sphinx 1.5.3 for RTDRich Bennett1-1/+1
Change-Id: Ib70e11d11edf82a5d9ac1d7d8d34a7ee460684a2 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-07[DOC-24] Add Component Template, Sphinx 1.6.3Rich Bennett1-1/+2
Change-Id: Ib810ef3354ff17da35c57f563ecd8e15e9250fa3 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-07-19[DOC-9] Index, sources validated & built with toxRich Bennett1-0/+8
Change-Id: I5a638eba279092ada8874d09130120e9ce085b06 Signed-off-by: Rich Bennett <rb2745@att.com>