🐛 update formatting to support again multi-line descriptions (#151)

* 🚧 update formatting logic for long description

- update tests once the relative imports are updated

* 🐛 remove typo in update shell script

* 🚧 update streamlit tests

🐛 Centering does not work for text after a blank line

* 🎨 remove unnecesary identation

- less confusing handling of files.

Author: enryH

bin/update_test_reports.sh

@@ -1,4 +1,4 @@
-§set -e
+set -e
 vuegen -dir docs/example_data/Basic_example_vuegen_demo_notebook -output_dir tests/report_examples/Basic_example_vuegen_demo_notebook
 
 vuegen -dir docs/example_data/Basic_example_vuegen_demo_notebook -output_dir tests/report_examples/Basic_example_vuegen_demo_notebook/html -rt html

docs/example_data/Basic_example_vuegen_demo_notebook/description.md

@@ -1 +1,6 @@
-A general description of the report.
+A general description of the report.
+
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.

src/vuegen/config_manager.py

@@ -211,7 +211,7 @@ def _read_description_file(self, folder_path: Path) -> str:
         """
         description_file = folder_path / "description.md"
         if description_file.exists():
-            ret = description_file.read_text().strip().replace("\n", "\n  ")
+            ret = description_file.read_text().strip()
             return f"{ret}\n"
         return ""
 

src/vuegen/quarto_reportview.py

@@ -129,7 +129,7 @@ def generate_report(self, output_dir: Optional[Path] = None) -> None:
 
             # Add description of the report
             if self.report.description:
-                qmd_content.append(f"""{self.report.description}""")
+                qmd_content.append(self.report.description)
 
             # If available add the graphical abstract
             if self.report.graphical_abstract:

src/vuegen/streamlit_reportview.py

@@ -424,17 +424,19 @@ def _format_text(
             )
 
         text = text.strip()  # get rid of new lines
-
-        return textwrap.dedent(
-            f"""
+        text = textwrap.indent(text, "                ")
+        ret = textwrap.dedent(
+            f"""\
             st.markdown(
-                (
-                    "<{tag} style='text-align: {text_align}; "
-                    "color: {color};'>{text}</{tag}>"
-                ),
+                '''
+                <{tag} style='text-align: {text_align};
+                color: {color};'>\n{text}
+                </{tag}>
+                ''',
                 unsafe_allow_html=True)
             """
         )
+        return ret
 
     def _generate_home_section(
         self,

tests/report_examples/Basic_example_vuegen_demo_notebook/docx/quarto_report/quarto_report.qmd

@@ -27,6 +27,11 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.
+
 ![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
 
 # Plots

tests/report_examples/Basic_example_vuegen_demo_notebook/html/quarto_report/quarto_report.qmd

@@ -53,6 +53,11 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.
+
 ![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
 
 # Plots

tests/report_examples/Basic_example_vuegen_demo_notebook/jupyter/quarto_report/quarto_report.qmd

@@ -53,6 +53,11 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.
+
 ![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
 
 # Plots

tests/report_examples/Basic_example_vuegen_demo_notebook/odt/quarto_report/quarto_report.qmd

@@ -27,6 +27,11 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.
+
 ![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
 
 # Plots

tests/report_examples/Basic_example_vuegen_demo_notebook/pdf/quarto_report/quarto_report.qmd

@@ -39,6 +39,11 @@ report_dir = Path().cwd()
 
 A general description of the report.
 
+It should test all major components which are available
+to be integrated into VueGen.
+
+Check our tests folder for examples of report files used to generate actual reports.
+
 ![](../../../../../docs/example_data/Basic_example_vuegen_demo_notebook/home_image.png){fig-alt= width=90%}
 
 # Plots