Add navigation for contributing and rel notes

Avaiga · Sep 17, 2024 · c1dbf91 · c1dbf91
1 parent 6d43f8f
commit c1dbf91
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/docs/contributing/index.md b/docs/contributing/index.md
@@ -1,4 +1,6 @@
-# Contributing to Taipy
+---
+title : Contributing to Taipy
+---
 
 Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are
 greatly appreciated! Every little help and credit will always be given.

diff --git a/mkdocs.yml_template b/mkdocs.yml_template
@@ -7,6 +7,15 @@ repo_name: taipy
 #strict: true
 copyright: © 2021-[YEAR] Avaiga
 nav:
+  - "Release Notes":
+    - "Release Notes": release_notes/index.md
+    - "Legacy": release_notes/legacy.md
+    - "Migration": release_notes/migration.md
+  - "Contributing":
+    - "Contributing": contributing/index.md
+    - "Code of Conduct": contributing/code_of_conduct.md
+    - "Contributors": contributing/contributors.md
+
   - "Tutorials":
     - "Tutorials": tutorials/index.md
     - "Fundamentals":

diff --git a/tools/_setup_generation/step_refman.py b/tools/_setup_generation/step_refman.py
@@ -44,9 +44,9 @@ def get_description(self) -> str:
 
     def enter(self, setup: Setup):
         os.environ["GENERATING_TAIPY_DOC"] = "true"
-        self.REFERENCE_DIR_PATH = os.path.join(
-            setup.docs_dir, RefManStep.REFERENCE_REL_PATH
-        )
+        # ...\docs\refmans\reference
+        self.REFERENCE_DIR_PATH = os.path.join(setup.docs_dir, RefManStep.REFERENCE_REL_PATH)
+        # ...\docs\userman\xrefs
         self.XREFS_PATH = os.path.join(setup.user_manuals_dir, "xrefs")
 
     def setup(self, setup: Setup) -> None:
@@ -109,9 +109,7 @@ def read_module(module):
                     if e.__module__.startswith(Setup.ROOT_PACKAGE):  # For local build
                         if e.__class__.__name__ == "NewType":
                             entry_type = TYPE_ID
-                    elif e.__module__ == "typing" and hasattr(
-                        e, "__name__"
-                    ):  # For Readthedoc build
+                    elif e.__module__ == "typing" and hasattr(e, "__name__"):  # For Readthedoc build
                         # Manually remove classes from 'typing'
                         if e.__name__ in ["NewType", "TypeVar", "overload", "cast"]:
                             continue
@@ -404,7 +402,6 @@ def generate_entries(
                 if entry_desc[2]:
                     entry_desc[2] = [p for p in entry_desc[2] if p != package]
         with open(self.XREFS_PATH, "w") as xrefs_output_file:
-            print(xrefs.get("taipy.gui", "ACHTUNG!!!"))
             xrefs_output_file.write(json.dumps(xrefs))
 
     @staticmethod