[fix] Use version branch of openwisp-docs #218

Fixes #218

Author: pandafy

.gitignore

@@ -18,6 +18,7 @@ openwrt-config-agent
 openwrt-monitoring-agent
 docker
 ansible
+openwisp-docs
 versions_map.json
 
 ### Python ###

build.py

@@ -234,47 +234,43 @@ def clone_or_update_repo(name, branch, dir_name, owner='openwisp'):
         repo_url = f'git@github.com:{repository}.git'
     else:
         repo_url = f'https://github.com/{repository}.git'
-    clone_path = os.path.join('modules', dir_name)
+    clone_path = os.path.abspath(os.path.join('modules', dir_name))
 
     if os.path.exists(clone_path):
         print(f"Repository '{name}' already exists. Updating...")
-        subprocess.run(
-            ['git', 'remote', 'set-branches', 'origin', branch],
-            cwd=clone_path,
-            check=True,
-        )
-        subprocess.run(
-            ['git', 'fetch', '--update-shallow', 'origin', branch],
-            cwd=clone_path,
-            check=True,
-        )
         subprocess.run(['git', 'checkout', branch], cwd=clone_path, check=True)
-        subprocess.run(['git', 'pull', 'origin', branch], cwd=clone_path, check=True)
     else:
         print(f"Cloning repository '{name}'...")
         subprocess.run(
             [
                 'git',
                 'clone',
-                '--single-branch',
-                '--branch',
-                branch,
-                '--depth',
-                '1',
                 repo_url,
                 clone_path,
             ],
             check=True,
         )
+        subprocess.run(
+            [
+                'git',
+                'checkout',
+                branch,
+            ],
+            cwd=clone_path,
+            check=True,
+        )
     # If the module contains a doc directory, copy it to the dir_name in the root.
     # Otherwise, copy the entire directory.
-    if os.path.islink(dir_name):
-        os.unlink(dir_name)
+    dest = dir_name
+    if dest != 'openwisp-docs':
+        dest = os.path.join('openwisp-docs', dir_name)
+    if os.path.islink(dest):
+        os.unlink(dest)
     src = os.path.join(clone_path, 'docs')
     # openwisp docs repo
     if not os.path.exists(src):
         src = clone_path
-    os.symlink(src, dir_name)
+    os.symlink(src, dest)
 
 
 def main():
@@ -333,14 +329,20 @@ def main():
 
         # If a module does not define a branch,
         # it will fallback to the version_branch.
-        version_branch = version.get('branch', version['name'])
+        version_branch = version.get('module_branch', version['name'])
+        docs_branch = version.get('docs_branch', 'master')
+        clone_or_update_repo(
+            name='openwisp-docs',
+            branch=docs_branch,
+            dir_name='openwisp-docs',
+        )
         for module in modules:
             clone_or_update_repo(
                 branch=module.pop('branch', version_branch),
                 **module,
             )
             module_dirs.append(module['dir_name'])
-        sphinx_src_dir = version.get('sphinx_src_dir', '.')
+        sphinx_src_dir = version.get('sphinx_src_dir', 'openwisp-docs')
         for format in ['spellcheck'] + args.formats:
             subprocess.run(
                 [
@@ -360,7 +362,10 @@ def main():
             )
         # Remove all temporary directories
         for dir in module_dirs:
-            os.unlink(dir)
+            path = dir
+            if path != 'openwisp-docs':
+                path = os.path.join('openwisp-docs', dir)
+            os.unlink(path)
 
     # Generate the index.html file which redirects to the stable version.
     env = Environment(loader=FileSystemLoader('_static'))

config.yml

@@ -31,9 +31,10 @@ modules:
     dir_name: docker
 versions:
   - name: dev
-    branch: master
+    module_branch: master
   - name: '24.11'
-    branch: '1.1'
+    docs_branch: '24.11'
+    module_branch: '1.1'
     modules:
       - name: ansible-openwisp2
         branch: '24.11'
@@ -50,4 +51,3 @@ versions:
       - name: openwisp-docs
         branch: 'v22.05'
         dir_name: openwisp-docs
-    sphinx_src_dir: ./openwisp-docs