summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2021-04-01Update conf.py and Documentation Release Notes for Honoluluandreasgeissler1-42/+48
Issue-ID: DOC-727 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I78ffbc5ba306ed9868fecbea24d07cfaf7e5d049
2021-03-19Add CPS in release notes, API, Architecture and Component pagesandreasgeissler1-63/+64
Update AAI UI in Component pages Issue-ID: DOC-721 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I7a66fbdf2876a26d2e8e45fd3cdc9dff122debb4
2021-03-18Policy/Clamp doc updateosgn422w1-1/+1
update the documentation to reflect the merge of clamp into Policy framework Issue-ID: REQ-684 Change-Id: I2948f7af24a4beadabed21a929f22c4e6984f55d Signed-off-by: osgn422w <gervais-martial.ngueko@intl.att.com>
2021-02-17[DOC] Run autopep8 on conf.pyGuillaume Lambert1-26/+36
Issue-ID: DOC-710 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I95b674bd459f97afcab05ce71f217ac70114cf1b
2021-02-02[DOC] Fix sphinx add_stylesheet deprecated methodGuillaume Lambert1-1/+1
by using add_css_file instead Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Ib8af980dc116fc551ca180c28cfb658bb6f86299
2021-02-02[DOC] Fix tox docs-linkcheck profile issuesGuillaume Lambert1-0/+12
- ignore URLs logically unreachable such as about:config - and create a code block for the git clone URL that is not reachable - ignore URLs with anchors (especially the ones ill-generated from external objects, mainly onap-integration) - enforce tox docs-lincheck profile Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I619d8d5697a35bf2bdf3ee2ed59ca9f5733e7802
2020-11-26Update conf.py with latestEric Debeau1-1/+1
Issue-ID: DOC-683 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I3f6b7061fbefd6052b22895eb8175a6e61914bc1
2020-11-25Correct intersphinx mapping for cert-serviceEric Debeau1-1/+1
Add platform in the and the '-' between cert and service Issue-ID: OOM-2526 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Ic798e8a8a3486e469e1623602891e13a8440b1d6 (cherry picked from commit 9dde43681f0819be43aeab1f05c2360ea1282ebb)
2020-11-16Updated the conf.pySofia Wallin1-1/+1
Edited the conf.py to guilin Issue-ID: DOC-683 Signed-off-by: Sofia Wallin <sofia.wallin@est.tech> Change-Id: I48eff1949e2bb69722b0c75efe08db18677aa082
2020-09-23Add link to ccsdk-oran documentationelinuxhenrik1-0/+1
Change-Id: I2f4d2d46c69dc308acc4d2b1f1e2b98def08b26a Issue-ID: CCSDK-2833 Signed-off-by: elinuxhenrik <henrik.b.andersson@est.tech>
2020-08-21Remove deprecated policy/engine docsPamela Dragosh1-1/+0
As suggested by Eric, removing the links to policy/engine repository documentation due to deprecation. Changed the reference to point to policy/parent, that should have been changed back in Dublin. Issue-ID: POLICY-2003 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com> Change-Id: Ic2dcca16e6f839bf5bb8c8a292ecc8f210c63df5 Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
2020-08-10Move cert-service documentation from aaf to oom/platformpawel1-1/+1
Issue-ID: OOM-2526 Signed-off-by: Pawel <pawel.kasperkiewicz@nokia.com> Change-Id: I9fefdbfcee36ac8763910833b80534880ad5d7b1
2020-06-26subprojects urls have been changedAric Gardner1-1/+1
docs.onap.org/projects old location was onap-doc.readthedocs.io Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I29688c00482647debbdd05bdbcc439d108e5c45d
2020-05-28Update css file name in conf.pylf-jobbuilder1-1/+1
ribbon.css is the correct name of the css file. Issue-ID: CIMAN-376 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I6f7346767ec656c12ceb7e8bcfa1763e64ee2791
2020-04-06Add osa to intersphinx inventoryAric Gardner1-0/+1
Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I455858f33fc843b20fd86a9092ae206dd446e4bb
2020-04-02Intersphinx linkingAric Gardner1-0/+74
each project now has its own read the docs page example: https://onap-oom-offline-installer.readthedocs.io/ this will redirect to the subproject location in this case: https://onap-doc.readthedocs.io/projects/onap-oom-offline-installer/ Added a new section on the main page: active-projects it shows linking in action. you can click through to the subproject docs from there. you will land on genindex.html This is not ideal To see why this is the case you can run python -m sphinx.ext.intersphinx 'https://onap-doc.readthedocs.io/ projects/onap-oom-offline-installer/en/latest/objects.inv' refer to https://gist.github.com/Aricg/27c739da7c35d201e9ca034df6e30ef6 we must link to one of the avaliable std:label This means that each project should add a lable to its main index page so that we can propery link it. eg, in their index.rst add .. _projectname-mainindex: or something we can agree on. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I0e1b506d113b9fbbcf2cb854482dfb557d8012b7
2020-02-07sphinxcontrib-needs extension to workAric Gardner1-0/+63
template added in the conf.py file that signifies the metadata allowed. necessary for the vnfrqts project. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I9c50dc18ac22ec7ca575186a4761e1a277387b50
2020-02-06Revert "exclude submodules"Aric Gardner1-1/+0
Now that we have a good build https://onap-doc.readthedocs.io/en/latest/ we can revert this change and start building out individual onap project docs. Issue-ID: CIMAN-33 This reverts commit d54f2498fdb85f9c298b29bdc51532bef7e594b4. Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I2c9ce3e8043eef14e9573060ed3fe1a0e1dddfb1
2020-02-06exclude submodulesAric Gardner1-0/+1
This change is needed for a single build this build will create and populate the onap-doc repository so that other rtdv3 projects can be a subproject of this master doc. the change will then be reverted, so that the old method of building docs continues to work Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I22686e4ef3061b4b32dfb494f31e284f80699073
2020-01-29Changes to doc configAric Gardner1-488/+7
now uses lfdocs-conf pip package. needed for future move to rtdv3 jobs. Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: Ic08a81100d8a4c59c2d326161662f207cfd9e25e
2019-05-22Turn on publishing of system messagesRich Bennett1-1/+1
Issue-ID: DOC-467 Signed-off-by: Rich Bennett <rb2745@att.com> Change-Id: Ia8a2181cdd00e3a47ba93b00ccd5ac7997b3dd89
2019-02-22Fix build timeout & upgrade sphinxRich Bennett1-3/+4
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-20Sidebar enhancementAndrea Visnyei1-3/+4
Added the Architecture and the Setting up ONAP pages to the sidebar Issue-ID: DOC-401 Change-Id: I90261a5abf2aebd603692c05d6a7a29ce1decddc Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2019-02-19Merge "Copyright updated to 2019"Rich Bennett1-1/+1
2019-02-19Sticky navigationGergely Csatari1-1/+2
Modification of the configuration ina way that the navigation menu is always visible. Change-Id: Ie5dc8e5afed071f49ae575ceb4411fbc1ebc0f37 Issue-ID: DOC-404 Signed-off-by: Gergely Csatari <gergely.csatari@nokia.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>
2019-02-14Copyright updated to 2019Manish Kumar1-1/+1
Issue-ID: DOC-397 Change-Id: Ia48250a35c3cd8e483d80b50d5539c6eac3a4c4f Signed-off-by: Manish Kumar <manishjpiet@gmail.com>
2018-09-13Switch theme and add report issueRich Bennett1-2/+5
Switch to sphinx_rtd_theme Add report issue in Jira with current page/release context Change-Id: Ie237ee4d084f2b8bd025acc7499d19563f6e3e68 Issue-ID: DOC-310 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-09-01Cherry pick beijing improvements to masterRich Bennett1-1/+1
Replicating changes made when finalizing Beijing branch in the doc master branch. Change-Id: Ib1da658aef8cb84f896c6abac23631579ec0b80c Issue-ID: DOC-280 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-07-12Add support for sphinx NEEDS DirectiveRich Bennett1-0/+62
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-22Add link check exceptionsRich Bennett1-20/+43
Add private address ranges and example URL names Add references to added or changed ui, ccsdk, and modeling rst files Change-Id: I913ac118ec4ea5e60522ac6ba29a8d7f9cff14c4 Issue-ID: DOC-268 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-05-08Add spellcheck and linkcheck exceptionsRich Bennett1-2/+29
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/+0
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-11-24Add .gitmodule entry for vvpRich Bennett1-2/+2
Update sphinx conf.py to show master branch Change-Id: Ib62ff4699b179c6acaf3fe2ffb11372d9b56bc85 Issue-ID: DOC-58 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-21Add Release, Version, and TagsRich Bennett1-3/+2
Sphinx Release=Amsterdam Version=1.0.0 Git tags 1.0.0-Amsterdam v1.0.0 Issue-ID: DOC-98 Signed-off-by: Rich Bennett <rb2745@att.com> Change-Id: Ic9237e175d1fbecbf2ecd2e1b350d530de9baf2a
2017-11-14Remove exclusion for files removed in SO-319Rich Bennett1-1/+0
Change-Id: I4cfb33c8b79c654e98d25fef51b86ee505948db1 Issue-ID: SO-319 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-08Remove AAI rst file exclusionRich Bennett1-1/+0
OfferedAPIs has been modified, should not cause RTD build timeout Change-Id: Ic9c573edbe8fccd372f6abaf323e4e0b4f1cfad1 Issue-ID: DOC-157 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-11-08Integrate architecture overviewRich Bennett1-2/+3
Adjusted headings to fit index Corrected references to images Made architecture provided by projects a reference list Added build time and dropped the sphinx version on footers Change-Id: I411ff51c5de2ad65c3c276d363d2fd3ed1ba35a7 Issue-ID: DOC-148 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-26Remove aai submodules aggregated in aai-commonRich Bennett1-0/+1
Temporarily exclude offeredapis.rst causing RTD updates to timeout until root cause of delay eliminated or RTD quota can be increased Change-Id: I39e495f8e82bbaa451e6ae2c5ec92234ad330de3 Issue-ID: DOC-140 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-24Integrate CLAMP added templatesRich Bennett1-2/+1
Integrate templates into Architeture and Release Notes Remove excluded path auth/aaf.git for master branch Change-Id: I49b7ee43823e27b99a7b20dff7d955e16691d912 Issue-ID: DOC-110 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-18Update Copyright and Licensing markingsRich Bennett1-2/+5
Add footer reference to CC4 and make Copyright 2017 ONAP Modify how to create documentation guide to describe appending copyrights on update contributions. Update Collections Titles Exclude aaf until source rst files are corrected for the next release. Change-Id: I3ed26910b2bbb7a15c7c2865e40ff1e5545a00ff Issue-ID: DOC-102 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-10-16Sync logging-analytics update release note listRich Bennett1-6/+8
Sync logging-analytis submodule reference Add Repo names of release notes list Configuration changes to evaluate theme and footnote options Change-Id: Ib65612908b1739d138f16387d866dbfcc583cdbb Issue-ID: DOC-41 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-09-18Remove linkcheck and add API examplesRich Bennett1-1/+7
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-09-13Ignore localhost links in sphinx linkcheck builderRich Bennett1-0/+3
Change-Id: I2048e723c052f8a468f75b0abc9661320cf76380 Issue-ID: DOC-34 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-25Remove VNFRQTS ExclusionRich Bennett1-2/+4
Remove Sphinx exclusion of VNFRQTS repositories that were causing all doc verify jobs to fail. These have been updated, should now verify, and be published when merged Improvements in the setup / getting started instructions for other project creating documentation Issue-Id: DOC-11 Change-Id: Ieb932dcaa0b4c39073e1e20cbdbe05bf6977a006 Signed-off-by: Rich Bennett <rb2745@att.com>
2017-08-24Update How To Guide & Git submodulesRich Bennett1-1/+2
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-16Updates to How to GuideRich Bennett1-1/+1
Improve How to Use Documentation Guide including display existing templates, consistency with the approved Jenkins job templates, and other editorial improvements Change-Id: I6a173a656acee2d675cb4af4c3070ab9ab9eb893 Issue-Id: DOC-59 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-4/+5
Change-Id: Ib810ef3354ff17da35c57f563ecd8e15e9250fa3 Signed-off-by: Rich Bennett <rb2745@att.com>