summaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
2023-05-25Updating parent/doc configuration script to use variableslapentafd1-12/+9
Issue-ID: POLICY-4127 Change-Id: I85e4309a0acd2c33f179ff0590eced2568d4d170 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2023-04-14Fix offeredapi documentationlapentafd1-4/+11
Deleted repeted lines. Fixed missing body in Post requests in the generated swagger pages, added OpenApi 3 support. Issue-ID: POLICY-4581 Change-Id: Id7558efeb210457e4e9c79df5e6e155d1525d3d4 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2023-04-06Update ACM rest api pagelapentafd1-1/+1
Unused file cleanup. Updated docs/clamp/acm/api-protocol/acm-rest-apis.rst Issue-ID: POLICY-4603 Change-Id: Ie8dd6989139f09b69f95bb42604b1ca8aa596d3c Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2023-04-04Update Policy Offered APIslapentafd1-2/+47
Swagger documentation rendered in ReDoc webpage. The html page is generated during the Sphinx build. The sphinx.builders.linkcheck reports as false positives the links that are generated dynamically, such as with the sphinxcontrib-redoc extension. Issue-ID: POLICY-4581 Change-Id: I9b720b961332689b144d5fe9d8be82be436d1c16 Signed-off-by: lapentafd <francesco.lapenta@est.tech>
2023-03-30Updated policy/acm OOM install docssaul.gill1-1/+2
Altered guide to allow install of policy fwk or acm components Added collapse directive to make page more readable Added overide.yaml instructions Added more detailed oom installation guide Issue-ID: POLICY-4607 Change-Id: Ie5de014f9651b1dceb340acd780216a2a75b4b90 Signed-off-by: saul.gill <saul.gill@est.tech>
2022-11-01Fix doc config files and dead linksliamfallon1-59/+41
Documentation config fixed as instructed. Configuration files have been copied from examples provided by the documentation project. Dead links are fixed as well, they cause build fails now. Issue-ID: POLICY-4426 Change-Id: Ied5ca5e5a24f7a625e5b2d94c46d0c2347c68ace Signed-off-by: liamfallon <liam.fallon@est.tech>
2022-05-10Update release notes for Jakartaliamfallon1-1/+49
Release notes for Jakarta. Issue-ID: POLICY-4072 Change-Id: I02a1168497f36c0094658cb7ece10613773bf62c Signed-off-by: liamfallon <liam.fallon@est.tech>
2022-04-14Remove false and useless intersphinx_mappingCédric Ollivier1-94/+0
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I753e9d8073489443dd03fad084f9d1bc6337ddd7
2021-10-12Fix warnings in PF documentation generationliamfallon1-1/+0
Geeneration of documents in the Policy Framework issued many warnings, for example missing links, hanging references, unreferenced pages and missing swagger, as well as bad formatting for code blocks. This commit cleans up all the warnings. Issue-ID: POLICY-3337 Change-Id: I20db6ff76cfb58a603317f5faf20c7479b77c13b Signed-off-by: liamfallon <liam.fallon@est.tech>
2021-09-27Update libs for sphinx and LF docs theme to match.adheli.tavares1-61/+0
Sphinx bump to 4.2.x didn't match LF theme for docs, so other libs needed to be adapted. Refer to commit /doc/+/124461 Issue-ID: POLICY-3363 Change-Id: Icfcf23725a7777ccaf10a28c0b7ad3bffc8d9f97 Signed-off-by: adheli.tavares <adheli.tavares@est.tech>
2021-07-19Add profile for generating Swagger documentsliamfallon1-7/+168
This commit adds a profile for generating Swagger documents and creating a tarball containing the swagger.json, swagger.html, and swagger.pdf files. The profile is triggered in any module when tsts are enabled (In other words when the skipTests flag is off), and when the following proerty is set: <swagger.generation.phase>post-integration-test</swagger.generation.phase> This profile assumes that a unit test exists that creates the following file: target/swagger/swagger.json If this file does not exist, the build will fail if the profile is invoked. Therefore, to generate the Swagger documentation tarball, a module must set the swagger.generation.phase propety AND have a unit test that generates the swagger.json file. Issue-ID: POLICY-3424 Change-Id: I8ff769e7a28bf0e00969d1bc677fee6908951d8a Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-11-12Update Policy release notes for GuilinJim Hahn1-1/+6
Also fixed broken headings and nested bullet lists in the 6.0.0 section. Also added extension for swaggerv2doc. Note: the version numbers for the images/artifactss assume there will be one more release of apex-pdp and drools-apps to fix the outstanding bugs. Issue-ID: POLICY-2889 Change-Id: I4749cb621a159e941622c3bd54d9a48d4212d007 Signed-off-by: Jim Hahn <jrh3@att.com>
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: I1f1e7b8a53ab068659732527930383794e627c8f
2020-05-12Fix warnings for Policy/engine in rst files.uj426b1-0/+1
Change-Id: Ic79f12b63feff8f55ec15127e88e2bfbd1cf42f6 Issue-ID: POLICY-2511 Signed-off-by: uj426b <uj426b@att.com>
2020-04-08Architecture documentation Section 1liamfallon1-1/+1
Issue-ID: POLICY-2399 Change-Id: I0050f457c2803299cb7f63fba00f676c2a7bb884 Signed-off-by: liamfallon <liam.fallon@est.tech>
2020-02-26Migrate policy-parent docsJessica Wagantall1-0/+15
Merging this will create https://onap-policy-parent.readthedocs.io This build will run in parallel to the current docs generation method until we are ready to cut over. Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I0c3c58710da92676bf622fb44f102a05daa8b2a0