aboutsummaryrefslogtreecommitdiffstats
path: root/docs/conf.py
AgeCommit message (Collapse)AuthorFilesLines
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