summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2022-10-12update examples and active config filesthmsdt1-2/+11
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ifdf67102aa90e992e3803e279c797143a4ab48c1
2022-08-10fix missing copyright in RTD footerthmsdt1-2/+2
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I972d59a9a190690ecaf7fe240a6e05291efa7335
2022-07-07format conf.py; fix link in setup guide; fix releasereposthmsdt1-2/+3
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I12ee49b841065a930b68f68e596f4778ba50c93f
2022-07-06Remove lf docs confCédric Ollivier1-4/+22
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I05be46029920367a2792c32da380dd19cdba06e3
2022-07-05Revert "add security related docs (osa)"Thomas Kulik1-4/+1
This reverts commit 6458ba752df13912f3497576949f85192a9ca8b5. Reason for revert: <build problems> Issue-ID: DOC-782 Change-Id: Ie07ea0d4b0d3bf1cb5d378d9b3b248e5d580fe5e Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2022-07-05Fix all incorrect anchors detected by linkcheckCédric Ollivier1-16/+0
It leverages the doc directive which suits this cases. There is no longer link ignored by linkcheck. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I416e378f28789504eee5b44778c8c8edc1e7723f
2022-06-27add security related docs (osa)thmsdt1-0/+4
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I8e4f6692c6249e16a1862ec533620c1a43a579d6
2022-06-27add missing sections to conf.pythmsdt1-0/+4
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2fdc0ae919f8a14d650f2cd9a745dcdf805e5d6a
2022-05-31remove repos without j branch from docsthmsdt1-5/+0
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie41998cefa08327be5eb3cedc659e69afb84bfbe
2022-05-02remove unmaintained repos from jakarta docsthmsdt1-14/+1
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ice20b360b2a438ee74a60d51d73292e8714b2531
2022-04-14Garbage the doc historyCédric Ollivier1-1/+0
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I6cbbbf2d2e76f8d5b7960c137be428224f0a7378
2022-03-17cleanup documentation (not branched, unmaintained) #3thmsdt1-82/+6
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I0d909771864aedcade4be8de7d73241ae8d615a5
2022-03-16cleanup documentation (not branched, unmaintained) #2thmsdt1-27/+25
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Idc449feac6e633257f84bc4cfc0d3b7442af3af7
2022-03-15cleanup documentation (not branched, unmaintained)thmsdt1-36/+58
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ia9c716545159499002ca153d68454d831204a307
2021-11-30fix entries for vnfsdk/model and dmaap/dbcapi in conf.py and related filesthmsdt1-3/+2
Issue-ID: DOC-771 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ic82970887cf419ba00e63bf4650b468da1c3f503
2021-11-15fixed wrong label 'Istanbul' to 'Latest'thmsdt1-4/+2
Issue-ID: DOC-771 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I99b8df907375785c55e398278746d15c51e14e2c
2021-11-12updated interspinx mappings in conf.py (master)thmsdt1-7/+8
Issue-ID: DOC-771 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2f8d86b4484897e87c9bff8fbd146e1b01ebcccf
2021-10-19Update the conf.py and ONAP component, release, architectur, apiAndreas Geissler1-7/+29
Issue-ID: DOC-771 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: I914805302832f9adf59a13174284365c9424066f
2021-10-06Add CPS Temporal documentation linksEric Debeau1-0/+1
Modify following files - conf.py for intersphinx link - developing/index.rst Issue-ID: DOC-769 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I576b538cbb7726dccaa072f7703107d0efb4063d
2021-09-29Add CPS DMI Plugin documentation linksEric Debeau1-0/+1
Modify following files - conf.py for intersphinx link - developing/index.rst Issue-ID: DOC-767 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: Iee1212eb5b2615296f2912ddb0f4f272ad929951
2021-09-24Correct configuration for Sphinx generationEric Debeau1-60/+0
- remove useless code in docs/conf.py - force lfdocs-confr~=0.7.5 in etc/requirements.txt - add funcparserlib==1.0.0a0 in etc/requirements.txt - enforce compatible versions in others packages Issue-ID: DOC-765 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I3e963dd2bdaaf5e484e1c3270674373eef3fce24
2021-05-06Merge "Template updates - sections"Andreas Geissler1-4/+2
2021-05-06Template updates - sectionsAndrea Visnyei1-4/+2
Instructions and examples added, notes commented out, review comments implemented Add example.com in the linkcheck_ignore Issue-ID: DOC-696 Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
2021-04-06Update the components list and move Portal to "unmaintained"andreasgeissler1-10/+12
Issue-ID: DOC-721 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: I668d593bd562a307a5e237bec6246c87c2424837
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>