Added --ignore-conf argument to ignore configuration file arguments for sphinx-versioned-docs in conf.py.

Author: devanshshukla99

docs/settings.rst

@@ -20,10 +20,6 @@ Configuration File Arguments
 
     Setting this variable will make sure that the ``Project home`` is listed on the versions selector badge/menu.
 
-.. option:: sv_prebuild
-
-    Pre-build all versions to make sure ``sphinx-build`` has no issues and pass-on the successful builds to ``sphinx-versioned-docs``. Default is `True`.
-
 .. option:: sv_select_branch
 
     Select any particular branches/tags to build.
@@ -60,6 +56,18 @@ Configuration File Arguments
 
     Force branch selection. Use this option to build detached head/commits. Default is `False`.
 
+.. option:: sv_floating_badge
+
+    Turns the version selector menu into a floating badge. Default is `False`.
+
+.. option:: sv_reset_intersphinx
+
+    Resets intersphinx mapping; acts as a patch for issue `#17 <https://github.com/devanshshukla99/sphinx-versioned-docs/issues/17>`__. Default is `False`.
+
+.. option:: sv_sphinx_compability
+
+    Adds compatibility for older sphinx versions by monkey patching certain functions. Default is `False`.
+
 
 Command Line Arguments
 ======================
@@ -109,6 +117,13 @@ These command line options must be specified when executing the ``sphinx-version
 
     Turns the version selector menu into a floating badge. Default is `False`.
 
+.. option:: --ignore-conf
+ 
+    Ignores conf.py configuration file arguments for sphinx-versioned-docs.
+
+    .. warning::
+        conf.py will still be used in sphinx!
+
 .. option:: --quite, --no-quite
 
     Silents the output from `sphinx`. Use `--no-quite` to get complete-output from `sphinx`. Default is `True`.

sphinx_versioned/__main__.py

@@ -59,6 +59,9 @@ def main(
     floating_badge: bool = typer.Option(
         False, "--floating-badge", "--badge", help="Turns the version selector menu into a floating badge."
     ),
+    ignore_conf: bool = typer.Option(
+        False, "--ignore-conf", help="Ignores conf.py configuration file arguments for sphinx-versioned-docs. Warning: conf.py will still be used in sphinx!"
+    ),
     quite: bool = typer.Option(
         True, help="Silent `sphinx`. Use `--no-quite` to get build output from `sphinx`."
     ),
@@ -102,6 +105,8 @@ def main(
         Main branch to which the top-level `index.html` redirects to. [Default = 'main']
     floating_badge : :class:`bool`
         Turns the version selector menu into a floating badge. [Default = `False`]
+    ignore_conf : :class:`bool`
+        Ignores conf.py configuration file arguments for sphinx-versioned-docs. Warning: conf.py will still be used in sphinx!
     quite : :class:`bool`
         Quite output from `sphinx`. Use `--no-quite` to get output from `sphinx`. [Default = `True`]
     verbose : :class:`bool`
@@ -121,24 +126,28 @@ def main(
     log.add(sys.stderr, format=logger_format, level=loglevel.upper())
 
     select_branch, exclude_branch = parse_branch_selection(branches)
+    config = {
+        "reset_intersphinx_mapping": reset_intersphinx_mapping,
+        "sphinx_compatibility": sphinx_compatibility,
+        "force_branches": force_branches,
+        "exclude_branch": exclude_branch,
+        "floating_badge": floating_badge,
+        "select_branch": select_branch,
+        "prebuild": prebuild,
+        "main_branch": main_branch,
+        "verbose": verbose,
+        "quite": quite,
+    }
+
+    filtered_config = {x: y for x, y in config.items() if y}
 
     DocsBuilder = VersionedDocs(
         chdir=chdir,
         local_conf=local_conf,
         output_dir=output_dir,
         git_root=git_root,
-        config={
-            "reset_intersphinx_mapping": reset_intersphinx_mapping,
-            "sphinx_compatibility": sphinx_compatibility,
-            "force_branches": force_branches,
-            "exclude_branch": exclude_branch,
-            "floating_badge": floating_badge,
-            "select_branch": select_branch,
-            "prebuild": prebuild,
-            "main_branch": main_branch,
-            "verbose": verbose,
-            "quite": quite,
-        },
+        ignore_conf=ignore_conf,
+        config=filtered_config
     )
 
     return DocsBuilder.run()

sphinx_versioned/build.py

@@ -36,7 +36,7 @@ class VersionedDocs:
         CLI configuration arguments.
     """
 
-    def __init__(self, chdir: str, local_conf: str, output_dir: str, git_root: str, config: dict) -> None:
+    def __init__(self, chdir: str, local_conf: str, output_dir: str, git_root: str, ignore_conf:bool, config: dict) -> None:
         # chdir if required
         if chdir:
             self.chdir = pathlib.Path(chdir)
@@ -50,8 +50,12 @@ def __init__(self, chdir: str, local_conf: str, output_dir: str, git_root: str,
         self.output_dir = pathlib.Path(output_dir)
         self.git_root = pathlib.Path(git_root) if git_root else None
 
+        # Ignore conf.py for configuration-file-arguments or not
+        self.ignore_conf = ignore_conf
+
         # CLI config variables
         self._raw_cli_config = config
+        log.debug(f"command line arugments: {self._raw_cli_config}")
 
         # Read sphinx-conf.py variables
         self.read_conf()
@@ -87,6 +91,10 @@ def read_conf(self) -> bool:
 
         log.success(f"located conf.py")
 
+        if self.ignore_conf:
+            self.config = self._raw_cli_config
+            return
+
         # Parse sphinx config file i.e. conf.py
         self._sphinx_conf = Config.read(self.local_conf.parent.absolute())
         sv_conf_values = {
@@ -95,12 +103,7 @@ def read_conf(self) -> bool:
         log.debug(f"Configuration file arugments: {sv_conf_values}")
 
         # Make a master config variable
-        self.config = self._raw_cli_config.copy()
-        for x, y in self.config.items():
-            if y or x not in sv_conf_values:
-                continue
-            self.config[x] = sv_conf_values.get(x)
-
+        self.config = sv_conf_values | self._raw_cli_config
         log.debug(f"master config: {self.config}")
         return
 
@@ -113,7 +116,7 @@ def configure_conf(self) -> None:
 
         if self.config.get("reset_intersphinx_mapping"):
             EventHandlers.RESET_INTERSPHINX_MAPPING = True
-            log.warning("Forcing --no-prebuild")
+            log.warning("forcing --no-prebuild")
             self.config["prebuild"] = False
 
         if self.config.get("sphinx_compatibility"):