Merge branch 'develop' into doc/kb/tips/long_running_callbacks

Avaiga · Oct 13, 2023 · dc205ce · dc205ce
2 parents 179ee4c + fdcd811
commit dc205ce
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/docs/knowledge_base/hidden.md b/docs/knowledge_base/hidden.md
@@ -34,7 +34,7 @@
 | 14  | Sharing a Taipy Application on Colab with Ngrok                         | Learn how to deploy your Taipy Application on Colab (Google Colab offers a high-performance Notebook environment with CPU and GPU access for Deep Learning), using a tunnel to the internet through a public URL created with Ngrok.                                                                            | Taipy Application on Colab | [Sharing a Taipy Application on Colab with Ngrok](https://www.taipy.io/tips/sharing-a-taipy-application-on-colab-with-ngrok/) |
 | 15  | [Taipy front-end in Jupyter Notebooks](tips/jupyter_notebooks/index.md) | Discover how to streamline your coding experience with Taipy in Jupyter Notebooks. Learn essential functions for seamless front-end updates without the need to restart the kernel. Optimize your Python scripts for efficiency today!                                                                          | Taipy in Jupyter Notebooks |                         [Taipy GUI in Jupyter Notebooks](https://www.taipy.io/tips/taipy-gui/taipy-gui-in-jupyter-notebooks/) |
 | 16  | Long-running Callbacks                                                  | Explore how Taipy's 'long-running callbacks' revolutionize web applications by ensuring server-client communication remains responsive during time-consuming tasks. Learn through practical examples in this article and unlock the potential of enhanced user experiences with Taipy.                          |   Long-running Callbacks   |                                                   [Long running Callbacks](https://www.taipy.io/tips/long-running-callbacks/) |
-| 17  | Multi-page application                                                  | Say goodbye to cluttered dashboards! Discover the power of multipage applications with Taipy. Organize your data and visualizations effortlessly, creating user-friendly and intuitive dashboards for enhanced insights. Simplify your data visualization journey today!                                        |   Multi-page application   |                                                    [Multi-page application](https://www.taipy.io/tips/multipage-application/) |
+| 17  | Multi-page application                                                  | Say goodbye to cluttered dashboards! Discover the power of multi-page applications with Taipy. Organize your data and visualizations effortlessly, creating user-friendly and intuitive dashboards for enhanced insights. Simplify your data visualization journey today!                                        |   Multi-page application   |                                                    [Multi-page application](https://www.taipy.io/tips/multipage-application/) |
 | 18  | Learn about using tables                                                | Discover the power of Taipy front-end tables – your go-to for data presentation and control. Learn key settings and features in this article, tailored for effortless table creation within data applications. Simplify your data management with Taipy today!                                                  |           Tables           |                                                           [Learn about Using tables](https://www.taipy.io/tips/using-tables/) |
 | 19  | The data nodes                                                          | Explore the world of data nodes in Taipy pipelines. Learn about their crucial role and how they seamlessly access data from diverse sources. This article is your gateway to understanding data nodes in Taipy!                                                                                                 |         Data nodes         |                                                                   [The data nodes](https://www.taipy.io/tips/the-data-nodes/) |
 | 20  | The CSS Style Kit                                                       | Elevate your Taipy applications with the all-new CSS Style Kit! Transform aesthetics effortlessly with predefined stylesheets, CSS variables, and utility classes. Discover how to customize your app's look and feel for a visually stunning experience.                                                       |       CSS Style Kit        |                                                             [The CSS Style Kit](https://www.taipy.io/tips/the-css-style-kit/) |

diff --git a/tools/_setup_generation/step_refman.py b/tools/_setup_generation/step_refman.py
@@ -340,7 +340,7 @@ def convert_to_pattern(input, dest):
                 os.mkdir(package_path)
                 package_output_path = os.path.join(package_path, "index.md")
                 self.navigation += (
-                    f"- \"Package: <code>{package}</code>\":\n  - {RefManStep.REFERENCE_REL_PATH}/pkg_{package}/index.md\n"
+                    f"- \"<code>{package}</code>\":\n  - {RefManStep.REFERENCE_REL_PATH}/pkg_{package}/index.md\n"
                 )
             else:
                 high_package_group = None
@@ -355,9 +355,11 @@ def convert_to_pattern(input, dest):
                         )
                     package_group = high_package_group
                     self.navigation += f"- {package_group}:\n"
+                package_nav_entry = package
                 if package_group:
                     self.navigation += "  "
-                self.navigation += f"- {package}: {RefManStep.REFERENCE_REL_PATH}/pkg_{package}.md\n"
+                    package_nav_entry = package[len(package_group):]
+                self.navigation += f"- \"<code>{package_nav_entry}</code>\": {RefManStep.REFERENCE_REL_PATH}/pkg_{package}.md\n"
                 package_output_path = os.path.join(
                     self.REFERENCE_DIR_PATH, f"pkg_{package}.md"
                 )

diff --git a/tools/postprocess.py b/tools/postprocess.py
@@ -431,6 +431,27 @@ def on_post_build(env):
                                             + article_match.group(2)
                                             + html_content[article_match.end():])
                             file_was_changed = True
+                    # Handle title and header in packages documentation file
+                    FONT_SIZE_CHANGE=''
+                    def code(s: str) -> str:
+                        return f"<code><font size='+2'>{s}</font></code>"
+
+                    fn_match = re.search(r"manuals(/|\\)reference\1pkg_taipy\1index.html", filename)
+                    if fn_match is not None: # The root 'taipy' package
+                        html_content = re.sub(f"(<h1>)taipy(</h1>)", f"\\1{code('taipy')}\\2", html_content)
+                        file_was_changed = True
+                    fn_match = re.search(r"manuals(/|\\)reference\1pkg_taipy(\..*)\1index.html", filename)
+                    if fn_match is not None:
+                        pkg = fn_match[2]
+                        sub_match = re.search(r"(\.\w+)(\..*)", pkg)
+                        if sub_match is None:
+                            html_content = re.sub(f"(<title>)Index\\s", f"\\1taipy{pkg} ", html_content)
+                            html_content = re.sub(f"(<h1>)Index(</h1>)", f"\\1{code('taipy'+pkg)}\\2", html_content)
+                            html_content = re.sub(f"(<h1>){pkg}(</h1>)", f"\\1{code('taipy'+pkg)}\\2", html_content)
+                        else:
+                            html_content = re.sub(f"(<title>)({sub_match[2]})\\s", f"\\1taipy{sub_match[1]}\\2 ", html_content)
+                            html_content = re.sub(f"(<h1>)(?:<code>){sub_match[2]}(?:</code>)(</h1>)", f"\\1{code('taipy'+pkg)}\\2", html_content)
+                        file_was_changed = True
 
                 if file_was_changed:
                     with open(filename, "w") as html_file: