Commit: cbb81a4d0e183bd7a3e75791624517f505de9ea1 - DocIdeas (hg)

Commit MetaInfo

• Révision: cbb81a4d0e183bd7a3e75791624517f505de9ea1 (tree)
• l'heure: 2022-05-24 21:28:05
• Auteur: Albert Mietus < albert AT mietus DOT nl >
• Commiter: Albert Mietus < albert AT mietus DOT nl >

Message de Log

Improvement on 'std' layout

Change Summary

• modified: _external_templates/conf/std_conf.py
• modified: _external_templates/static/SwBMnl+rtfd.css
• add: _external_templates/conf/std_needs.py
• add: _external_templates/static/std_needs.css

Modification

diff -r d9c3a68e5516 -r cbb81a4d0e18 _external_templates/conf/std_conf.py
--- a/_external_templates/conf/std_conf.py	Fri May 20 16:52:43 2022 +0200
+++ b/_external_templates/conf/std_conf.py	Tue May 24 14:28:05 2022 +0200
@@ -44,20 +44,20 @@
 }
 html_style = 'SwBMnl+rtfd.css'
 
-# # HTML-Slides (using Hieroglyph)
-# #-------------------------------
-# extensions.append('hieroglyph')
-#
-# slide_theme = 'slides'
-# slide_levels = 2
-#
-# slide_theme_options = {'custom_css': 'SwBMnl-hieroglyph_slides=article.css'}
-#
-# slide_link_to_html=False
-# slide_link_html_to_slides=False
-
 
 # sphinx.ext.todo
 #-----------------
 extensions.append('sphinx.ext.todo')
 todo_include_todos=True
+
+
+# Needs
+#------
+extensions.append('sphinxcontrib.needs')
+needs_include_needs = True
+needs_id_required = True
+needs_id_regex = r'^[A-Z][A-Za-z]*_[A-Za-z0-9-]{2,}'
+
+
+from std_needs import needs_types, needs_layouts
+needs_default_layout = 'clean_collapsed'

diff -r d9c3a68e5516 -r cbb81a4d0e18 _external_templates/conf/std_needs.py
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/_external_templates/conf/std_needs.py	Tue May 24 14:28:05 2022 +0200
@@ -0,0 +1,19 @@
+needs_types = [
+    dict(directive="resolution", title="Resolution",     prefix="R_", color="#9DC5BB", style="boundary"),
+    dict(directive="use",        title="UseCase",        prefix="U_", color="#C5EBC3", style="usecase"), #Note: usecase does not nest -- needed for :np:
+    dict(directive="spec",       title="Specification",  prefix="S_", color="#FEDCD2", style="component"),
+    dict(directive="impl",       title="Implementation", prefix="I_", color="#DF744A", style="artifact"),
+    dict(directive="verify",     title="Verify",         prefix="V_", color="#F6E27F", style="folder"),
+    dict(directive="risk",       title="Jeopardize",     prefix="J_", color="#AA1234", style="queue"),
+]
+
+needs_layouts = {
+    'clean_collapsed': {'grid': 'simple',
+                 'layout': {
+                     'head': [
+                         '<<meta("type_name")>>: **<<meta("title")>>** <<meta_id()>>  <<collapse_button("meta", '
+                         'collapsed="icon:arrow-down-circle", visible="icon:arrow-right-circle", initial=True)>> '],
+                     'meta': [
+                         '<<meta_all(no_links=True)>>',
+                         '<<meta_links_all()>>'],
+                 }}}

diff -r d9c3a68e5516 -r cbb81a4d0e18 _external_templates/static/SwBMnl+rtfd.css
--- a/_external_templates/static/SwBMnl+rtfd.css	Fri May 20 16:52:43 2022 +0200
+++ b/_external_templates/static/SwBMnl+rtfd.css	Tue May 24 14:28:05 2022 +0200
@@ -38,6 +38,7 @@
     margin-left: -0.8ex;
 }
 
+.rst-content dl.footnote *  { margin-bottom: 0; padding: 0;}
 div.GAM-extra #postcardHeader .blogdate {
     color: #000066; background: #c0c0c0;
     text-align: right;
@@ -66,3 +67,6 @@
     border: 1px solid #c0c0c0;
     border-radius: 33%;
 }
+.rst-content .sidebar p.sidebar-title {margin-bottom: 0;}
+.rst-content .sidebar div.local li p  {margin: 0;}
+

diff -r d9c3a68e5516 -r cbb81a4d0e18 _external_templates/static/std_needs.css
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/_external_templates/static/std_needs.css	Tue May 24 14:28:05 2022 +0200
@@ -0,0 +1,49 @@
+/* -*- coding: utf-8-unix -*-
+* By ALbert Mietus, 2022. No (C) Copyright.
+*/
+
+/*
+ * Needs
+ */
+
+
+/* Requirements are body text. Don't make it smaller,lighter, denser 'table-text' */
+.rst-content  table.docutils.need tr *:not(.admonition) p  {font-size: 1rem; margin-bottom: 0.2rem; color: black; }
+.rst-content  table.docutils.need div.admonition,
+.rst-content  table.docutils.need ul.simple { margin-bottom: 0.4rem;}
+
+/* Need head(er) en meta (links, labels, ect) can be less prominent */
+.rst-content  table.need tr.head td,
+.rst-content  table.need tr.meta td {padding: 2px 16px;}
+.rst-content  table.need tr.meta .line-block {line-height: normal;}
+
+/* Make clear boxes around a requirements ... */
+.rst-content  table.need tr  {border: 2px solid #000066;}
+
+/* .. and color them to type (keep in sync with (std) conf.py::needs_types */
+.rst-content table.need.needs_type_resolution:not(.field-list) tbody tr:not(.meta) td {background-color: #9DC5BB;}
+.rst-content table.need.needs_type_use:not(.field-list) tbody tr:not(.meta) td {background-color: #C5EBC3;}
+.rst-content table.need.needs_type_spec:not(.field-list) tbody tr:not(.meta) td {background-color: #FEDCD2;}
+.rst-content table.need.needs_type_impl:not(.field-list) tbody tr:not(.meta) td {background-color: #DF744A;}
+.rst-content table.need.needs_type_verify:not(.field-list) tbody tr:not(.meta) td {background-color: #F6E27F;}
+.rst-content table.need.needs_type_risk:not(.field-list) tbody tr:not(.meta) td {background-color: #AA1234; color:white;}
+.rst-content table.need.needs_type_risk:not(.field-list) tbody tr:not(.meta) td p { color:white;}
+
+/* Fancy, icon-style need-type-name */
+table.need tr.head td .needs_type_name  {
+    color: #000066;
+    text-decoration: underline overline;
+    -webkit-text-decoration-color: #000066;
+    text-decoration-color: #000066;
+}
+
+/*HACK*/
+table.rtm-rotated-head th {height: 20em;} /*Magic Number*/
+table.rtm-rotated-head th:not(:first-child)>p {
+    transform: translate(0px, 30px) /* Magic Numbers */
+                        rotate(-90deg);
+    width: 20px;
+}
+
+.rst-content table.need dl.simple {margin-top: 1ex; margin-bottom: 1ex;}
+.rst-content table.need dl.simple dt {margin-top: 1ex; margin-bottom: 0.2ex;}