💚 Move execution of split_readme script to sphinx config and rename github action files

Author: sayalaruano

.github/workflows/cdci.yml renamed to .github/workflows/cicd.yml

@@ -1,4 +1,4 @@
-name: Python package
+name: CICD Python Package
 
 on:
   push:

.github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: Test documentation building, and publish report to GitHub Pages
+name: Docs
 
 on:
   push:
@@ -27,9 +27,6 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -e .[docs]
-      - name: Split README into sections
-        run: |
-          python docs/split_readme.py
       - name: Build references
         run: |
             cd docs

docs/conf.py

@@ -137,7 +137,16 @@
     PROJECT_ROOT = Path(__file__).parent.parent
     PACKAGE_ROOT = PROJECT_ROOT / "src" / "vuegen"
 
+    def run_split_readme(_):
+        print("[conf.py] Splitting README.md into sections...")
+        from split_readme import process_readme
+
+        readme_path = PROJECT_ROOT / "README.md"
+        output_dir = PROJECT_ROOT / "docs" / "sections_readme"
+        process_readme(readme_path, output_dir)
+
     def run_apidoc(_):
+        print("[conf.py] Running sphinx-apidoc...")
         from sphinx.ext import apidoc
 
         apidoc.main(
@@ -155,4 +164,5 @@ def run_apidoc(_):
         )
 
     def setup(app):
+        app.connect("builder-inited", run_split_readme)
         app.connect("builder-inited", run_apidoc)

docs/split_readme.py

@@ -52,16 +52,14 @@ def convert_gfm_to_sphinx(content, links):
     return content
 
 
-def process_readme():
-    readme_path = Path(__file__).resolve().parent.parent / "README.md"
-    readme = readme_path.read_text()
+def process_readme(readme_path, output_dir):
+    readme = Path(readme_path).read_text()
 
     # Extract links from README
     links = extract_links_from_readme(readme)
 
-    # Create docs/sections directory
-    output_dir = Path("./sections_readme")
-    output_dir.mkdir(exist_ok=True)
+    # Create output directory
+    output_dir.mkdir(exist_ok=True, parents=True)
 
     for section_title, filename in SECTION_MAPPING.items():
         content = extract_section(readme, section_title)
@@ -76,4 +74,6 @@ def process_readme():
 
 
 if __name__ == "__main__":
-    process_readme()
+    default_readme = Path(__file__).resolve().parent.parent / "README.md"
+    output_sections_readme = Path("./sections_readme")
+    process_readme(default_readme, output_sections_readme)