Satisfy pylint.

Author: samsrabin

build_docs

@@ -8,7 +8,7 @@ This should be run from the directory that contains the Makefile for
 building the documentation.
 """
 
-from doc_builder import build_docs
+from doc_builder import build_docs  # pylint: disable=import-error
 
 if __name__ == "__main__":
     build_docs.main()

build_docs_to_publish

@@ -4,8 +4,9 @@
 Loop through all versions of the documentation, building each and moving it to a directory for
 publication.
 
-# Adapted from https://www.codingwiththomas.com/blog/my-sphinx-best-practice-for-a-multiversion-documentation-in-different-languages
-# (last visited 2025-05-20)
+Adapted from https://www.codingwiththomas.com/blog/my-sphinx-best-practice-for-a-multiversion-
+documentation-in-different-languages
+(last visited 2025-05-20)
 """
 
 import sys
@@ -33,7 +34,6 @@ from version_list import (
 
 
 # Path to certain important files
-# TODO: Make these cmd-line options
 SOURCE = "source"
 VERSIONS_PY = os.path.join("version_list.py")
 MAKEFILE = "Makefile"
@@ -110,6 +110,10 @@ def check_version_list():
 
 
 def main():
+    """
+    Loop through all versions of the documentation, building each and moving it to a directory for
+    publication.
+    """
     # Set up parser
     parser = argparse.ArgumentParser()
 

doc_builder/build_commands.py

@@ -4,7 +4,7 @@
 
 import os
 import pathlib
-from doc_builder import sys_utils
+from doc_builder import sys_utils  # pylint: disable=import-error
 
 DEFAULT_DOCKER_IMAGE = "ghcr.io/escomp/ctsm/ctsm-docs:v1.0.1"
 
@@ -75,8 +75,6 @@ def get_build_command(
     warnings_as_warnings=False,
     docker_image=DEFAULT_DOCKER_IMAGE,
     conf_py_path=None,
-    static_path=None,
-    templates_path=None,
 ):
     # pylint: disable=too-many-arguments,too-many-locals
     """Return a string giving the build command.

doc_builder/build_docs_shared_args.py

@@ -3,8 +3,6 @@
 group.
 """
 
-import os
-
 # pylint: disable=import-error,no-name-in-module
 from .build_commands import DEFAULT_DOCKER_IMAGE
 

doc_builder/sys_utils.py

@@ -19,10 +19,10 @@ def check_permanent_file(filename):
     cmd = f"git add . && git diff --quiet {filename} && git diff --cached --quiet {filename}"
     try:
         subprocess.check_output(cmd, shell=True)
-    except subprocess.CalledProcessError as e:
+    except subprocess.CalledProcessError as exception:
         subprocess.check_output("git reset", shell=True)  # Unstage files staged by `git add`
         msg = f"Important file/submodule may contain uncommitted changes: '{filename}'"
-        raise RuntimeError(msg) from e
+        raise RuntimeError(msg) from exception
 
 
 def get_git_head_or_branch():

test/test_unit_cmdline_args.py

@@ -5,7 +5,7 @@
 import unittest
 
 import os
-from doc_builder.build_docs import is_web_url, commandline_options
+from doc_builder.build_docs import is_web_url, commandline_options  # pylint: disable=import-error
 
 
 class TestCmdlineArgs(unittest.TestCase):

test/test_unit_get_build_command.py

@@ -5,7 +5,7 @@
 import os
 import unittest
 from unittest.mock import patch
-from doc_builder.build_commands import get_build_command
+from doc_builder.build_commands import get_build_command  # pylint: disable=import-error
 
 # Allow names that pylint doesn't like, because otherwise I find it hard
 # to make readable unit test names

test/test_unit_get_build_dir.py

@@ -12,9 +12,11 @@
     # For python3
     from unittest import mock
 import os
+
+# pylint: disable=import-error,no-name-in-module
 from test.test_utils.sys_utils_fake import (
     make_fake_isdir,
-)  # pylint: disable=import-error,no-name-in-module
+)
 from doc_builder.build_commands import get_build_dir