summaryrefslogtreecommitdiffstats
path: root/tox.ini
AgeCommit message (Collapse)AuthorFilesLines
2022-07-05Fix all incorrect anchors detected by linkcheckCédric Ollivier1-1/+1
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
2021-12-20fix sphinx config example files and update readmethmsdt1-7/+7
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I1facd195d3fddf158ebdd7deb3c8882e7db35277
2021-09-28Split concreate and abstract dependenciesCédric Ollivier1-7/+26
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-05-06Merge "Template updates - sections"Andreas Geissler1-0/+9
2021-05-06Template updates - sectionsAndrea Visnyei1-0/+9
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-23[DOC] Decrease Sphinx tox profiles logs verbosityGuillaume Lambert1-3/+3
to ease gate failures analysis as proposed by Eric. Issue-ID: DOC-710 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I5fe51e5794f58ca0200be57aa161d2f965523776
2021-02-17[DOC] Add python linters for conf.py in tox.iniGuillaume Lambert1-0/+10
and configure them with some project default standards Issue-ID: DOC-710 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I94505a4db4b64b77dfb37bc4fc041d2e0264c900
2021-02-10[DOC] Use words whitelist default filenameGuillaume Lambert1-1/+1
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I00c67d2c749023e9f342f27edff62f21af45a563
2021-02-02[DOC] Fix tox docs-linkcheck profile issuesGuillaume Lambert1-1/+1
- 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
2021-02-02[DOC] Reactivate docs-linkcheck profileGuillaume Lambert1-8/+3
so that it can be used to identify broken links. Since there are still issues with some links, force tox results to success. Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: Iec1a5d913ad4fe6823476be545cb833084f146e5
2021-02-02[DOC] Enforce warnings at docs buildtimeGuillaume Lambert1-1/+1
Issue-ID: DOC-692 Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com> Change-Id: I36294591e42737592ffecdd5ec8f7d231d3c50d1
2020-02-05Fix readthedocs.ymlAric Gardner1-5/+10
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-2/+2
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-11-29remove parallelisation to save memorymrichomme1-3/+3
Issue-ID: DOC-419 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: Iebe3e4af80da72491e45970c7c42a8631e9bb98d
2019-11-29force Python3 usemrichomme1-0/+4
Issue-ID: DOC-419 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: I8a043280da97745b5f418df14557a4ea2e4b72d6
2019-09-05DOC - Fixing doc linking issueHagop Bozawglanian1-1/+1
This might be a solution to why the doc project is not linking to other projects. There is an incorrect submodule that does not exist that is trying to be pulled, this updates that. Issue-ID: DOC-548 Signed-off-by: Hagop Bozawglanian <hagop.bozawglanian@att.com> Change-Id: I055ce062b9a0ed205d35ae5bb0bb2ee51c30484c
2019-05-15Prepare master for dublin branchRich Bennett1-1/+1
Include all properties on git module reference Complete the modeling/genericparser integration Increase build threads Change-Id: I8b103a1a80962e13597c5e5af03f327daf437efc Issue-ID: DOC-467 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-30Apply casablanca improvements to smsummaryRich Bennett1-2/+0
Use simpler git submodule status summary Remove automatic use in master branch Change-Id: Ib2e300bc2eabd3a6aed8fbd6805234f5d6a4ee7c Issue-ID: DOC-332 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-04Reduce sphinx build threadsRich Bennett1-1/+1
Reduce build threads to reduce peak memory Change-Id: I88c037aec18d953f6e1bb75b59a0e6a94a5e1376 Issue-ID: DOC-334 Signed-off-by: Rich Bennett <rb2745@att.com>
2018-11-02Add submodule information summary when running toxRich Bennett1-1/+6
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-09-13Switch theme and add report issueRich Bennett1-1/+1
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-04-26Add tox environment for spellcheckRich Bennett1-1/+8
Updates to how-to use documentation for linkcheck and spellcheck Initial list of validword exceptions for immediate use of tox -espellcheck Validword exceptions will be improved when DOC-262 is complete Corrections of RST references based on recent Beijing contributions Change-Id: Ic82de1088fd961c2ad91493e8736777aede1cdb1 Signed-off-by: Rich Bennett <rb2745@att.com> Issue-ID: DOC-94
2017-11-13Pull submodules when running toxCédric Ollivier1-0/+10
Otherwise it only works via jjobs but tox is also designed for users. It creates a new venv to ease testing it before integrating in jjobs. The documentation is updated as well to refer to the new venv. Issue-ID: DOC-159 Change-Id: Ida2ad14ebcf54ab776c2439dd83e74364432af46 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
2017-09-29Allow multiple sphinx-build threads on verify jobRich Bennett1-2/+2
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-2/+2
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-07-19[DOC-9] Index, sources validated & built with toxRich Bennett1-0/+15
Change-Id: I5a638eba279092ada8874d09130120e9ce085b06 Signed-off-by: Rich Bennett <rb2745@att.com>