strictdoc 0.0.42a5__tar.gz → 0.0.42a6__tar.gz

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: strictdoc
-Version: 0.0.42a5
+Version: 0.0.42a6
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.0.42a5"
+__version__ = "0.0.42a6"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/cli/cli_arg_parser.py

@@ -1,7 +1,6 @@
 import argparse
 import os
 import sys
-from enum import Enum
 from typing import List, Optional
 
 from strictdoc.backend.reqif.sdoc_reqif_fields import ReqIFProfile
@@ -10,7 +9,7 @@ from strictdoc.core.environment import SDocRuntimeEnvironment
 from strictdoc.core.project_config import ProjectConfig, ProjectFeature
 from strictdoc.helpers.auto_described import auto_described
 
-EXPORT_FORMATS = ["html", "html-standalone", "rst", "excel", "reqif-sdoc"]
+EXPORT_FORMATS = ["html", "rst", "excel", "reqif-sdoc"]
 EXCEL_PARSERS = ["basic"]
 
 
@@ -303,12 +302,6 @@ class ServerCommandConfig:
         self.port: Optional[int] = port
 
 
-class ExportMode(Enum):
-    DOCTREE = 1
-    STANDALONE = 2
-    DOCTREE_AND_STANDALONE = 3
-
-
 class ExportCommandConfig:  # pylint: disable=too-many-instance-attributes
     def __init__(  # pylint: disable=too-many-arguments
         self,
@@ -356,15 +349,6 @@ class ExportCommandConfig:  # pylint: disable=too-many-instance-attributes
         assert self._server_port is not None
         return self._server_port
 
-    def get_export_mode(self):
-        if "html" in self.formats:
-            if "html-standalone" in self.formats:
-                return ExportMode.DOCTREE_AND_STANDALONE
-            return ExportMode.DOCTREE
-        if "html-standalone" in self.formats:
-            return ExportMode.STANDALONE
-        raise NotImplementedError
-
     @property
     def strictdoc_root_path(self):
         return self.environment.path_to_strictdoc
@@ -391,6 +375,22 @@ class ExportCommandConfig:  # pylint: disable=too-many-instance-attributes
         if self.project_title is None:
             self.project_title = project_config.project_title
         self.dir_for_sdoc_assets = project_config.dir_for_sdoc_assets
+
+        if self.experimental_enable_file_traceability:
+            deprecation_message = (
+                "warning: "
+                "'--experimental-enable-file-traceability' command-line "
+                "option will be deprecated. Instead, activate the option in "
+                "the strictdoc.toml config file as follows:\n"
+                "```\n"
+                "[project]\n\n"
+                "features = [\n"
+                '  "REQUIREMENT_TO_SOURCE_TRACEABILITY"\n'
+                "]\n"
+                "```"
+            )
+            print(deprecation_message)  # noqa: T201
+
         self.experimental_enable_file_traceability = (
             self.experimental_enable_file_traceability
             or project_config.is_feature_activated(

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/core/document_meta.py

@@ -87,6 +87,13 @@ class DocumentMeta:
             f"{self.document_filename_base}-DEEP-TRACE.html"
         )
 
+    def get_html_standalone_document_link(self):
+        return (
+            f"{self.output_document_dir_rel_path}"
+            f"/"
+            f"{self.document_filename_base}.standalone.html"
+        )
+
     def get_html_link(self, document_type: DocumentType, other_doc_level):
         assert isinstance(document_type, DocumentType)
 

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/core/project_config.py

@@ -23,6 +23,8 @@ class ProjectFeature(str, Enum):
     REQUIREMENTS_COVERAGE_SCREEN = "REQUIREMENTS_COVERAGE_SCREEN"
     REQUIREMENT_TO_SOURCE_TRACEABILITY = "REQUIREMENT_TO_SOURCE_TRACEABILITY"
 
+    ALL_FEATURES = "ALL_FEATURES"
+
     @staticmethod
     def all():
         return list(map(lambda c: c.value, ProjectFeature))
@@ -79,6 +81,15 @@ class ProjectConfig:  # pylint: disable=too-many-instance-attributes
     def is_feature_activated(self, feature: ProjectFeature):
         return feature in self.project_features
 
+    def is_activated_table_screen(self):
+        return ProjectFeature.TABLE_SCREEN in self.project_features
+
+    def is_activated_trace_screen(self):
+        return ProjectFeature.TRACEABILITY_SCREEN in self.project_features
+
+    def is_activated_deep_trace_screen(self):
+        return ProjectFeature.DEEP_TRACEABILITY_SCREEN in self.project_features
+
     def is_activated_requirements_to_source_traceability(self):
         return (
             ProjectFeature.REQUIREMENT_TO_SOURCE_TRACEABILITY
@@ -90,9 +101,13 @@ class ProjectConfig:  # pylint: disable=too-many-instance-attributes
             ProjectFeature.REQUIREMENTS_COVERAGE_SCREEN in self.project_features
         )
 
-    @staticmethod
-    def is_reqif_feature_activated():
-        return ProjectFeature.REQIF
+    def is_activated_standalone_document(self):
+        return (
+            ProjectFeature.STANDALONE_DOCUMENT_SCREEN in self.project_features
+        )
+
+    def is_activated_reqif(self) -> bool:
+        return ProjectFeature.REQIF in self.project_features
 
 
 class ProjectConfigLoader:
@@ -163,6 +178,8 @@ class ProjectConfigLoader:
                         f"'{feature}'."
                     )
                     sys.exit(1)
+            if ProjectFeature.ALL_FEATURES in project_features:
+                project_features = ProjectFeature.all()
 
             include_doc_paths = project_content.get(
                 "include_doc_paths", include_doc_paths

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/_static/element.css

@@ -527,6 +527,7 @@ a.strictdoc__version:hover {
 [data-viewtype="table"] [data-viewtype_link="table"],
 [data-viewtype="traceability"] [data-viewtype_link="traceability"],
 [data-viewtype="deep_traceability"] [data-viewtype_link="deep_traceability"],
+[data-viewtype="standalone_document"] [data-viewtype_link="standalone_document"],
 .viewtype__menu_item.active {
   background-color: var(--color-bg-accent);
   color: var(--color-fg-accent);

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/generators/document_tree.py

@@ -35,6 +35,7 @@ class DocumentTreeHTMLGenerator:
             traceability_index=traceability_index,
             link_renderer=link_renderer,
             strictdoc_version=__version__,
+            standalone=False,
         )
 
         return output

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/generators/requirements_coverage.py

@@ -47,6 +47,7 @@ class RequirementsCoverageHTMLGenerator:
             renderer=markup_renderer,
             document_type=DocumentType.deeptrace(),
             strictdoc_version=__version__,
+            standalone=False,
         )
 
         return output

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/generators/source_file_coverage.py

@@ -30,6 +30,7 @@ class SourceFileCoverageHTMLGenerator:
             traceability_index=traceability_index,
             link_renderer=link_renderer,
             strictdoc_version=__version__,
+            standalone=False,
         )
 
         return output

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/generators/source_file_view_generator.py

@@ -136,5 +136,6 @@ class SourceFileViewHTMLGenerator:
             renderer=markup_renderer,
             document_type=document_type,
             strictdoc_version=__version__,
+            standalone=False,
         )
         return output

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/html_generator.py

@@ -4,7 +4,7 @@ from pathlib import Path
 from typing import Optional, Tuple
 
 from strictdoc.backend.sdoc.models.document import Document
-from strictdoc.cli.cli_arg_parser import ExportCommandConfig, ExportMode
+from strictdoc.cli.cli_arg_parser import ExportCommandConfig
 from strictdoc.core.document_meta import DocumentMeta
 from strictdoc.core.project_config import ProjectConfig, ProjectFeature
 from strictdoc.core.source_tree import SourceTree
@@ -174,7 +174,6 @@ class HTMLGenerator:
         if specific_documents is None:
             specific_documents = DocumentType.all()
 
-        export_mode = config.get_export_mode()
         assert document.meta is not None
 
         document_meta: DocumentMeta = document.meta
@@ -193,87 +192,78 @@ class HTMLGenerator:
             document,
         )
 
-        if export_mode in (
-            ExportMode.DOCTREE,
-            ExportMode.DOCTREE_AND_STANDALONE,
-        ):
-            if DocumentType.DOCUMENT in specific_documents:
-                # Single Document pages
-                document_content = DocumentHTMLGenerator.export(
-                    config,
-                    project_config,
-                    document,
-                    traceability_index,
-                    markup_renderer,
-                    link_renderer,
-                    standalone=False,
-                )
-                document_out_file = document_meta.get_html_doc_path()
-                with open(document_out_file, "w", encoding="utf8") as file:
-                    file.write(document_content)
+        if DocumentType.DOCUMENT in specific_documents:
+            # Single Document pages
+            document_content = DocumentHTMLGenerator.export(
+                config,
+                project_config,
+                document,
+                traceability_index,
+                markup_renderer,
+                link_renderer,
+                standalone=False,
+            )
+            document_out_file = document_meta.get_html_doc_path()
+            with open(document_out_file, "w", encoding="utf8") as file:
+                file.write(document_content)
 
-            # Single Document Table pages
-            if (
-                project_config.is_feature_activated(ProjectFeature.TABLE_SCREEN)
-                and DocumentType.TABLE in specific_documents
-            ):
-                document_content = DocumentTableHTMLGenerator.export(
-                    config,
-                    project_config,
-                    document,
-                    traceability_index,
-                    markup_renderer,
-                    link_renderer,
-                )
-                document_out_file = document_meta.get_html_table_path()
-                with open(document_out_file, "w", encoding="utf8") as file:
-                    file.write(document_content)
+        # Single Document Table pages
+        if (
+            project_config.is_feature_activated(ProjectFeature.TABLE_SCREEN)
+            and DocumentType.TABLE in specific_documents
+        ):
+            document_content = DocumentTableHTMLGenerator.export(
+                config,
+                project_config,
+                document,
+                traceability_index,
+                markup_renderer,
+                link_renderer,
+            )
+            document_out_file = document_meta.get_html_table_path()
+            with open(document_out_file, "w", encoding="utf8") as file:
+                file.write(document_content)
 
-            # Single Document Traceability pages
-            if (
-                project_config.is_feature_activated(
-                    ProjectFeature.TRACEABILITY_SCREEN
-                )
-                and DocumentType.TRACE in specific_documents
-            ):
-                document_content = DocumentTraceHTMLGenerator.export(
-                    config,
-                    project_config,
-                    document,
-                    traceability_index,
-                    markup_renderer,
-                    link_renderer,
-                )
-                document_out_file = document_meta.get_html_traceability_path()
-                with open(document_out_file, "w", encoding="utf8") as file:
-                    file.write(document_content)
+        # Single Document Traceability pages
+        if (
+            project_config.is_feature_activated(
+                ProjectFeature.TRACEABILITY_SCREEN
+            )
+            and DocumentType.TRACE in specific_documents
+        ):
+            document_content = DocumentTraceHTMLGenerator.export(
+                config,
+                project_config,
+                document,
+                traceability_index,
+                markup_renderer,
+                link_renderer,
+            )
+            document_out_file = document_meta.get_html_traceability_path()
+            with open(document_out_file, "w", encoding="utf8") as file:
+                file.write(document_content)
 
-            # Single Document Deep Traceability pages
-            if (
-                project_config.is_feature_activated(
-                    ProjectFeature.DEEP_TRACEABILITY_SCREEN
-                )
-                and DocumentType.DEEPTRACE in specific_documents
-            ):
-                document_content = DocumentDeepTraceHTMLGenerator.export_deep(
-                    config,
-                    project_config,
-                    document,
-                    traceability_index,
-                    markup_renderer,
-                    link_renderer,
-                )
-                document_out_file = (
-                    document_meta.get_html_deep_traceability_path()
-                )
-                with open(document_out_file, "w", encoding="utf8") as file:
-                    file.write(document_content)
+        # Single Document Deep Traceability pages
+        if (
+            project_config.is_feature_activated(
+                ProjectFeature.DEEP_TRACEABILITY_SCREEN
+            )
+            and DocumentType.DEEPTRACE in specific_documents
+        ):
+            document_content = DocumentDeepTraceHTMLGenerator.export_deep(
+                config,
+                project_config,
+                document,
+                traceability_index,
+                markup_renderer,
+                link_renderer,
+            )
+            document_out_file = document_meta.get_html_deep_traceability_path()
+            with open(document_out_file, "w", encoding="utf8") as file:
+                file.write(document_content)
 
         if project_config.is_feature_activated(
             ProjectFeature.STANDALONE_DOCUMENT_SCREEN
-        ) or export_mode in (
-            ExportMode.STANDALONE,
-            ExportMode.DOCTREE_AND_STANDALONE,
         ):
             # Single Document pages (standalone)
             document_content = DocumentHTMLGenerator.export(

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/base.jinja.html

@@ -41,9 +41,11 @@
       {% endblock layout_nav %}
     </nav>
 
+    {%- if not standalone -%}
     <aside class="layout_tree">
       {% block tree_content %}{% endblock tree_content %}
     </aside>
+    {%- endif -%}
 
     {%- with toc_position = "right" -%}
       <aside

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/components/node/root.jinja

@@ -23,7 +23,7 @@
     {% endblock %}
 
     {# node_controls #}
-    {%- if config.is_running_on_server -%}
+    {%- if config.is_running_on_server and not standalone -%}
     {% include "components/node/node_controls/index.jinja" %}
     {%- endif -%}
 

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/_shared/viewtype_menu.jinja

@@ -1,4 +1,4 @@
-{%- if not standalone -%}
+{%- assert not standalone -%}
 <div class="viewtype">
   <div
     id="viewtype_handler"
@@ -24,6 +24,7 @@
         href="{{document.meta.get_root_path_prefix()}}/{{document.meta.get_html_doc_link()}}">
         Document</a>
     </li>
+    {%- if project_config.is_activated_table_screen() -%}
     <li>
       <a
         data-viewtype_link="table"
@@ -32,6 +33,8 @@
         href="{{document.meta.get_root_path_prefix()}}/{{document.meta.get_html_table_link()}}">
         Table</a>
     </li>
+    {%- endif -%}
+    {%- if project_config.is_activated_trace_screen() -%}
     <li>
       <a
         data-viewtype_link="traceability"
@@ -40,6 +43,8 @@
         href="{{document.meta.get_root_path_prefix()}}/{{document.meta.get_html_traceability_link()}}">
         Traceability</a>
     </li>
+    {%- endif -%}
+    {%- if project_config.is_activated_deep_trace_screen() -%}
     <li>
       <a
         data-viewtype_link="deep_traceability"
@@ -48,6 +53,16 @@
         href="{{document.meta.get_root_path_prefix()}}/{{document.meta.get_html_deep_traceability_link()}}">
       Deep traceability</a>
     </li>
+    {%- endif -%}
+    {%- if project_config.is_activated_standalone_document() -%}
+    <li>
+      <a
+        data-viewtype_link="standalone_document"
+        class="viewtype__menu_item"
+        title="Go to Standalone Document view"
+        href="{{document.meta.get_root_path_prefix()}}/{{document.meta.get_html_standalone_document_link()}}">
+      Standalone</a>
+    </li>
+    {%- endif -%}
   </menu>
 </div>
-{%- endif -%}

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/document/actions.jinja

@@ -5,6 +5,7 @@
 #}
 <turbo-frame>
   <div class="actions_group">
+    {%- if not standalone -%}
     <a
       href="/actions/document/edit_grammar?document_mid={{ document.node_id }}"
       class="action_button"
@@ -14,11 +15,14 @@
       data-testid="document-edit-grammar-action"
     >{% include "_res/svg_ico16_gear.jinja.html" %} Edit grammar</a>
 
+    {%- if project_config.is_activated_reqif() -%}
     <a
       class="action_button"
       href="/reqif/export_document/{{ document.node_id }}"
       data-testid="document-export-reqif-action"
     >Export to ReqIF</a>
+    {%- endif -%}
+    {%- endif -%}
   </div>
 </turbo-frame>
 {%- endif -%}

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/document/index.jinja

@@ -8,10 +8,12 @@
 {% endblock head_css %}
 
 {% block head_scripts %}
+  {%- if not standalone -%}
   <script type="text/javascript" src="{{ link_renderer.render_static_url('viewtype_menu.js') }}"></script>
+  {%- endif -%}
   <script type="text/javascript" src="{{ link_renderer.render_static_url('resizable_bar.js') }}"></script>
 
-  {%- if config.is_running_on_server -%}
+  {%- if config.is_running_on_server and not standalone -%}
   <script type="module">
     import hotwiredTurbo from "{{ link_renderer.render_static_url('turbo.js') }}";
     import { Application, Controller } from "{{ link_renderer.render_static_url('stimulus.js') }}";
@@ -34,7 +36,7 @@
   {{ super() }}
 {% endblock head_scripts %}
 {% block title %}{{ document.title }} - {{ template_type }}{% endblock title %}
-{% block viewtype %}document{% endblock viewtype %}
+{% block viewtype %}{{ "document" if not standalone else "standalone_document" }}{% endblock viewtype %}
 
 {% block layout_nav %}
   {%- if not standalone -%}
@@ -50,12 +52,22 @@
   {% include "screens/document/_shared/resizable_bar_with_toc.jinja" %}
 {% endblock toc_content %}
 
-{% block header_content %}
-  {%- with
-      header__items=[
+{%- if not standalone -%}
+  {%- set header_items = [
         "screens/document/_shared/frame_header_document_title.jinja",
         "screens/document/_shared/viewtype_menu.jinja"
-      ],
+      ]
+  -%}
+{%- else -%}
+  {%- set header_items = [
+        "screens/document/_shared/frame_header_document_title.jinja",
+      ]
+  -%}
+{%- endif -%}
+
+{% block header_content %}
+  {%- with
+      header__items=header_items,
       header__last="screens/document/document/actions.jinja"
   -%}
     {% include "components/header/index.jinja" %}

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/table/index.jinja

@@ -6,7 +6,7 @@
   <script type="text/javascript" src="{{link_renderer.render_static_url('viewtype_menu.js')}}"></script>
   <script type="text/javascript" src="{{link_renderer.render_static_url('resizable_bar.js')}}"></script>
 
-  {%- if config.is_running_on_server -%}
+  {%- if config.is_running_on_server and not standalone -%}
   <script type="module">
     import { Application, Controller } from "{{ link_renderer.render_static_url('stimulus.js') }}";
     window.Stimulus = Application.start();

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/traceability/index.jinja

@@ -11,7 +11,7 @@
   <script type="text/javascript" src="{{ link_renderer.render_static_url('viewtype_menu.js') }}"></script>
   <script type="text/javascript" src="{{ link_renderer.render_static_url('resizable_bar.js') }}"></script>
 
-  {%- if config.is_running_on_server -%}
+  {%- if config.is_running_on_server and not standalone -%}
   <script type="module">
     import hotwiredTurbo from "{{ link_renderer.render_static_url('turbo.js') }}";
     import { Application, Controller } from "{{ link_renderer.render_static_url('stimulus.js') }}";

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/document/traceability_deep/index.jinja

@@ -11,7 +11,7 @@
   <script type="text/javascript" src="{{ link_renderer.render_static_url('viewtype_menu.js') }}"></script>
   <script type="text/javascript" src="{{ link_renderer.render_static_url('resizable_bar.js') }}"></script>
 
-  {%- if config.is_running_on_server -%}
+  {%- if config.is_running_on_server and not standalone -%}
   <script type="module">
     import hotwiredTurbo from "{{ link_renderer.render_static_url('turbo.js')}}";
     import { Application, Controller } from "{{ link_renderer.render_static_url('stimulus.js') }}";

strictdoc-0.0.42a6/strictdoc/export/html/templates/screens/project_index/actions.jinja

@@ -0,0 +1,36 @@
+{%- if config.is_running_on_server -%}
+{#
+  This turbo frame is important because it enables
+  the child turbo links below.
+#}
+<turbo-frame>
+  <div class="actions_group">
+    <a
+      class="action_button"
+      href="/actions/project_index/new_document"
+      data-turbo="true"
+      title="Add new document"
+      data-testid="tree-add-document-action"
+    >{% include "_res/svg_ico16_add.jinja.html" %} Add document</a>
+
+    {%- if project_config.is_activated_reqif() -%}
+      <a
+        class="action_button"
+        href="/actions/project_index/import_reqif_document_form"
+        data-turbo="true"
+        title="Import document tree from ReqIF"
+        data-testid="tree-import-reqif-action"
+      >Import from ReqIF</a>
+
+      {%- if not document_tree_iterator.is_empty_tree() -%}
+        <a
+          class="action_button"
+          href="/reqif/export_tree"
+          title="Export document tree to ReqIF"
+          data-testid="tree-export-reqif-action"
+        >Export to ReqIF</a>
+      {%- endif -%}
+    {%- endif -%}
+  </div>
+</turbo-frame>
+{%- endif -%}

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/templates/screens/project_index/index.jinja

@@ -8,7 +8,7 @@
 {% endblock head_css %}
 
 {% block head_scripts %}
-{%- if config.is_running_on_server -%}
+{%- if config.is_running_on_server and not standalone -%}
   <script type="module">
     import hotwiredTurbo from "{{ link_renderer.render_static_url_with_prefix('turbo.js') }}";
     import { Application, Controller } from "{{ link_renderer.render_static_url_with_prefix('stimulus.js') }}";

{strictdoc-0.0.42a5 → strictdoc-0.0.42a6}/strictdoc/export/html/tools/html_embedded.py

@@ -47,7 +47,10 @@ class EmbeddableTag:
         elif tag.name == "script":
             if "type" in tag.attrs:
                 type_value = tag.attrs["type"]
-                if type_value == "text/javascript":
+                if (
+                    type_value in ("text/javascript", "module")
+                    and "src" in tag.attrs
+                ):
                     return EmbeddableTag(EmbeddableTag.JS, tag.attrs["src"])
         elif tag.name == "img":
             if "src" in tag.attrs: