From 16a880a7a7339f5e0e5d7f5048e15e8ea9a7089f Mon Sep 17 00:00:00 2001 From: "adheli.tavares" Date: Mon, 27 Sep 2021 10:39:40 +0100 Subject: [PATCH] Update libs for sphinx and LF docs theme to match. 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 --- docs/conf.py | 61 ---------------------------------------------- docs/requirements-docs.txt | 18 +++++++------- 2 files changed, 9 insertions(+), 70 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 11918233..8f01b443 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,4 +1,3 @@ -from docutils.parsers.rst import directives from docs_conf.conf import * branch = 'latest' @@ -120,63 +119,3 @@ html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_css_file("css/ribbon.css") - - -needs_extra_options = { - "target": directives.unchanged, - "keyword": directives.unchanged, - "introduced": directives.unchanged, - "updated": directives.unchanged, - "impacts": directives.unchanged, - "validation_mode": directives.unchanged, - "validated_by": directives.unchanged, - "test": directives.unchanged, - "test_case": directives.unchanged, - "test_file": directives.unchanged, - "notes": directives.unchanged, -} - -needs_id_regex = "^[A-Z0-9]+-[A-Z0-9]+" -needs_id_required = True -needs_title_optional = True - -needs_template_collapse = """ -.. _{{id}}: - -{% if hide == false -%} -.. role:: needs_tag -.. role:: needs_status -.. role:: needs_type -.. role:: needs_id -.. role:: needs_title - -.. rst-class:: need -.. rst-class:: need_{{type_name}} - -.. container:: need - - `{{id}}` - {{content|indent(4)}} - - .. container:: toggle - - .. container:: header - - Details - -{% if status and status|upper != "NONE" and not hide_status %} | status: :needs_status:`{{status}}`{% endif %} -{% if tags and not hide_tags %} | tags: :needs_tag:`{{tags|join("` :needs_tag:`")}}`{% endif %} -{% if keyword %} | keyword: `{{keyword}}` {% endif %} -{% if target %} | target: `{{target}}` {% endif %} -{% if introduced %} | introduced: `{{introduced}}` {% endif %} -{% if updated %} | updated: `{{updated}}` {% endif %} -{% if impacts %} | impacts: `{{impacts}}` {% endif %} -{% if validation_mode %} | validation mode: `{{validation_mode}}` {% endif %} -{% if validated_by %} | validated by: `{{validated_by}}` {% endif %} -{% if test %} | test: `{{test}}` {% endif %} -{% if test_case %} | test case: {{test_case}} {% endif %} -{% if test_file %} | test file: `{{test_file}}` {% endif %} -{% if notes %} | notes: `{{notes}}` {% endif %} - | children: :need_incoming:`{{id}}` - | parents: :need_outgoing:`{{id}}` -{% endif -%} -""" diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index a743c226..12c4de1a 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -4,12 +4,12 @@ doc8 docutils setuptools six -sphinx_rtd_theme>=0.4.3 -sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 -sphinxcontrib-nwdiag -sphinxcontrib-seqdiag -sphinxcontrib-swaggerdoc -sphinxcontrib-plantuml -sphinx_bootstrap_theme -lfdocs-conf +lfdocs-conf~=0.7.5 +funcparserlib~=1.0.0a0 +sphinxcontrib.blockdiag~=2.0.0 +sphinxcontrib-needs<0.6.0 +sphinxcontrib.plantuml~=0.21 +sphinxcontrib.nwdiag~=2.0.0 +sphinxcontrib-seqdiag~=2.0.0 +sphinxcontrib-swaggerdoc~=0.1.7 +sphinx-rtd-theme~=1.0.0 -- 2.16.6