Renamed internal variable for force branch

Author: devanshshukla99

sphinx_versioned/__main__.py

@@ -76,7 +76,7 @@ def main(
     loglevel: str = typer.Option(
         "info", "-log", "--log", help="Provide logging level. Example --log debug, default=info"
     ),
-    force_branches: bool = typer.Option(
+    force_branch: bool = typer.Option(
         False,
         "--force",
         help="Force branch selection. Use this option to build detached head/commits. [Default: False]",
@@ -115,7 +115,7 @@ def main(
         Passed directly to sphinx. Specify more than once for more logging in sphinx. [Default = `False`]
     loglevel : :class:`str`
         Provide logging level. Example `--log` debug, [Default='info']
-    force_branches : :class:`str`
+    force_branch : :class:`str`
         Force branch selection. Use this option to build detached head/commits. [Default = `False`]
 
     Returns
@@ -133,7 +133,7 @@ def main(
     config = {
         "reset_intersphinx_mapping": reset_intersphinx_mapping,
         "sphinx_compatibility": sphinx_compatibility,
-        "force_branches": force_branches,
+        "force_branch": force_branch,
         "exclude_branch": exclude_branch,
         "floating_badge": floating_badge,
         "select_branch": select_branch,

sphinx_versioned/build.py

@@ -58,7 +58,7 @@ def __init__(self, config: dict, debug: bool = False) -> None:
 
         # if `--force` is supplied with no `--main-branch`, make the `_active_branch` as the `main_branch`
         if not self.config.get("main_branch"):
-            if self.config.get("force_branches"):
+            if self.config.get("force_branch"):
                 self.config["main_branch"] = self.versions.active_branch.name
             else:
                 self.config["main_branch"] = "main"
@@ -109,7 +109,7 @@ def read_conf(self) -> bool:
 
     def configure_conf(self) -> None:
         # Initialize GitVersions instance
-        self.versions = GitVersions(self.git_root, self.output_dir, self.config.get("force_branches"))
+        self.versions = GitVersions(self.git_root, self.output_dir, self.config.get("force_branch"))
 
         if self.config.get("floating_badge"):
             EventHandlers.FLYOUT_FLOATING_BADGE = True

sphinx_versioned/versions.py

@@ -69,15 +69,15 @@ class GitVersions(_BranchTag):
         Git repository root directory.
     build_directory : :class:`str`
         Path of build directory.
-    force_branches : :class:`bool`
+    force_branch : :class:`bool`
         This option allows `GitVersions` to treat the detached commits as normal branches.
         Use this option to build docs for detached head/commits.
     """
 
-    def __init__(self, git_root: str, build_directory: str, force_branches: bool) -> None:
+    def __init__(self, git_root: str, build_directory: str, force_branch: bool) -> None:
         self.git_root = git_root
         self.build_directory = pathlib.Path(build_directory)
-        self.force_branches = force_branches
+        self.force_branch = force_branch
 
         # for detached head
         self._active_branch = None
@@ -116,7 +116,7 @@ def _parse_branches(self) -> bool:
         # check if if the current git status is detached, if yes, and if `--force` is supplied -> append:
         if self.repo.head.is_detached:
             log.warning(f"git head detached {self.repo.head.is_detached}")
-            if self.force_branches:
+            if self.force_branch:
                 log.debug("Forcing detached commit into PseudoBranch")
                 self.all_versions.append(PseudoBranch(self.repo.head.object.hexsha))