summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEric Debeau <eric.debeau@orange.com>2021-09-23 20:58:26 +0200
committerEric Debeau <eric.debeau@orange.com>2021-09-24 14:39:17 +0200
commit0a6b64ccc3340f625551c00f300186dbba0f3221 (patch)
tree835b5a1108953b40168295fcf741be2f9e9160cc
parent07910a58d707e17c6d87ca2c62defb97d77fc78e (diff)
Correct configuration for Sphinx generation
- 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
-rw-r--r--docs/conf.py60
-rw-r--r--etc/requirements.txt15
2 files changed, 8 insertions, 67 deletions
diff --git a/docs/conf.py b/docs/conf.py
index 11918233b..4d7b9db5d 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'
@@ -121,62 +120,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/etc/requirements.txt b/etc/requirements.txt
index 9f5b2aa35..edffc4b5d 100644
--- a/etc/requirements.txt
+++ b/etc/requirements.txt
@@ -1,8 +1,9 @@
-sphinx_rtd_theme
-sphinxcontrib-blockdiag
+lfdocs-conf~=0.7.5
+funcparserlib~=1.0.0a0
+sphinxcontrib.blockdiag~=2.0.0
sphinxcontrib-needs<0.6.0
-sphinxcontrib-nwdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-lfdocs-conf
+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