summaryrefslogtreecommitdiffstats
path: root/etc
AgeCommit message (Collapse)AuthorFilesLines
2022-11-02[OOM] Add sphinx_toolbox for OOMefiacor2-0/+2
Signed-off-by: efiacor <fiachra.corcoran@est.tech> Change-Id: Ie070ece8c9b0b5c84fe59c3499daa286d36b174e Issue-ID: OOM-3028 (cherry picked from commit db486fc190b9e2817598ff0ec5cafc3ce1bf7732)
2022-10-12update examples and active config filesthmsdt1-1/+2
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ifdf67102aa90e992e3803e279c797143a4ab48c1
2022-09-05Add upper-constraints needed by oomCédric Ollivier1-0/+4
See comment in https://gerrit.onap.org/r/c/oom/+/130716 Issue-ID: DOC-798 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I21a035b8c9d7503dc6e82606da3c5dc5a0ccc477
2022-08-30Bump lfdocs-confLukasz Rajewski1-1/+1
lfdocs 0.7.0 requires sphinxcontrib-needs<=0.5.6 while ONAP upper constraints require 0.7.9. Version 0.8.0 removes this strict dependency on sphinxcontrib-needs Issue-ID: DOC-799 Signed-off-by: Lukasz Rajewski <lukasz.rajewski@t-mobile.pl> Change-Id: Iff9a62ce07758e47504933c7f4f9b21eba131bf1
2022-08-29Revert downgrade sphinxcontrib-needsCédric Ollivier1-1/+1
We can now use the latest version as lfdocs-conf is now fixed [1]. [1] https://gerrit.linuxfoundation.org/infra/c/releng/docs-conf/+/70536 Issue-ID: DOC-782 Change-Id: Iaffaf0e8dd32a7b7ec994fb88f2c035097d0cca2 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
2022-08-25Temporarily downgrade sphinxcontrib-needsCédric Ollivier1-1/+1
As lfdocs-conf falsy forces 0.5.6 [1], we must temporarily downgrade the version till lfdocs-conf is fixed. [1] https://gerrit.linuxfoundation.org/infra/c/releng/docs-conf/+/70536 Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Ie4ddd50c49290bbbf4bd8fa8a9a4f5e5878db93b
2022-08-24Upgrade upper-constraintsCédric Ollivier2-353/+410
It completes the upgrade to Yoga's upper-contraints.txt Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Ic103ac24047160d6868ab165c488f6a6f73acb18
2022-07-06Remove lf docs confCédric Ollivier1-1/+3
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I05be46029920367a2792c32da380dd19cdba06e3
2022-03-21Add bounds to sphinx requirementCédric Ollivier1-0/+2
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I481348ed97433c6cccc029890ff17d4b46b08254
2021-12-20fix sphinx config example files and update readmethmsdt1-0/+0
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I1facd195d3fddf158ebdd7deb3c8882e7db35277
2021-09-29Remove indirect depsCédric Ollivier2-10/+1
It leverages the latest lfdocs-conf (0.7.7) updates Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Id2b63f273ddfb41487b6424e3d14fbdf4cbd837d
2021-09-28Make funcparserlib + lfdocs-conf work on RTDCédric Ollivier1-1/+3
RTD doesn't manage upper constraints. We do add here bounds (abstract dependencies) until lfdocs-conf is fixed. Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I7e59613f0be37b85b02a3bf208e454e1d1ca69a4
2021-09-28Split concreate and abstract dependenciesCédric Ollivier3-9/+603
It adds 2 upper-constraints to pin all the dependencies. It modifies a little bit the official upper-constraints.txt from OpenStack due to Sphinx (4.2.0 as asked by lfdocs-conf vs 3.5.2) and due to setuptools (58.1.0 as used in ONAP gates vs 54.1.1). In a long run, etc/upper-constraints.os.txt should be removed once ONAP is synced with OpenStack. For it's part, etc/upper-constraints.onap.txt should be centralized for all ONAP projects and then removed from this particular project. It should be noted that lfdocs-conf still mismatches concrete and abstract deps. Issue-ID: DOC-765 Change-Id: Iccf1e4cdab93acc9c55acb16cb11e3b3fcef3291 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
2021-09-24Correct configuration for Sphinx generationEric Debeau1-7/+8
- 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-02-15[DOC] Remove useless entries in requirements.txtGuillaume Lambert1-8/+1
Issue-ID: DOC-710 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Iaa23acd1b87900ec96eb832ecbe339cf5f553198
2021-02-02[DOC] Use sphinxcontrib-needs versions < 0.6.0Guillaume Lambert1-1/+1
This latest version introduces a new services support functionality - that cannot be easily disabled here - and that requires additional configuration parameters to link GitHub issues. We cannot provide these parameters since this project uses JIRA. As a result, sphinx generates a warning. https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I3bfa231467804729deacbe70f1180c06b3eec978
2020-02-05Fix readthedocs.ymlAric Gardner1-0/+15
Also fix conf.py lint errors etc/requirements.txt is hardcoded in rtd config to support older builds I cannot change it untill the next release Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: I27f1dcf32d226ea094b20ad275b318d07fa9648b
2020-01-29Changes to doc configAric Gardner1-14/+0
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
2020-01-27Removed pin on sphinxcontrib-blockdiagAric Gardner1-1/+1
This broke local tox builds for me on python3 added a tiny change to index.rst so that this will trigger a verify Issue-ID: CIMAN-33 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> Change-Id: Iad3047f02c7e00f3aac1bb998e3750363479df1f
2019-12-16Pin sphinxcontrib-blockdiag versionJessica Wagantall1-2/+2
We need to use sphinxcontrib-blockdiag 1.5.5 for now as it was the last working version compatible with the rest of our tools Issue-ID: DOC-576 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: Iac4c9d588f0876408bd0a646b541c0fd5f8f6c55
2019-12-16Updated Sphinx version to 2.3.0andreasgeissler1-1/+1
Issue-ID: DOC-576 Signed-off-by: andreasgeissler <andreas-geissler@telekom.de> Change-Id: Ib25d51830546f323268acc9686d2078eee2f98a4
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>