minor config and doc changes

.gitignore

@@ -49,6 +49,7 @@ instance/
 lib/
 lib64/
 local_settings.py
+node_modules/
 nosetests.xml
 parts/
 pip-delete-this-directory.txt

.vscode/settings.json

@@ -35,7 +35,6 @@
         "**/__pycache__": true
     },
     "files.insertFinalNewline": true,
-    "python.analysis.typeCheckingMode": "strict",
     "python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
     "python.testing.pytestArgs": [
         "tests",

Makefile

@@ -16,11 +16,7 @@ build: ## build the PyPi release
 
 .PHONY: docs
 docs: ## delete build artifacts, start sphinx-autobuild server, & open browser window
-	@if [[ -z "$${CI}" ]]; then \
-		$(MAKE) --no-print-directory -C docs docs; \
-	else \
-		$(MAKE) --no-print-directory docs-changes; \
-	fi
+	$(MAKE) --no-print-directory -C docs docs;
 
 docs-changes: ## build HTML docs; only builds changes detected by Sphinx
 	@$(MAKE) --no-print-directory -C docs html

README.md

@@ -6,4 +6,4 @@
 [![pypi](https://img.shields.io/pypi/v/f-lib?style=flat)](https://pypi.org/project/f-lib/)
 [![renovate](https://img.shields.io/badge/enabled-brightgreen?logo=renovatebot&logoColor=%2373afae&label=renovate)](https://developer.mend.io/github/finleyfamily/f-lib)
 
-A library of useful functions and classes for python projects.
+A library of useful functions and classes for Python projects.

docs/Makefile

@@ -18,7 +18,7 @@ clean:
 docs: clean html-watch ## remove old build artifacts & start sphinx-autobuild server
 
 html-watch: ## start sphinx-autobuild server & open a browser window
-	@poetry run sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) --open-browser
+	@poetry run sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) --watch ../f_lib --open-browser
 
 open:
 	@open build/html/index.html

docs/source/conf.py

@@ -9,8 +9,6 @@
 from datetime import date
 from pathlib import Path
 
-from pkg_resources import get_distribution
-
 ROOT_DIR = Path(__file__).parent.parent.parent
 DOC_SRC = ROOT_DIR / "docs" / "source"
 
@@ -21,7 +19,7 @@
 project = PYPROJECT_TOML["tool"]["poetry"]["name"]
 copyright = f"{date.today().year}, Kyle Finley"  # noqa: A001, DTZ011
 author = PYPROJECT_TOML["tool"]["poetry"]["authors"][0]
-version = get_distribution(project).version
+version = PYPROJECT_TOML["tool"]["poetry"]["version"]
 release = ".".join(version.split(".")[:2])  # short X.Y version
 
 

f_lib/mixins/_cli_interface.py

@@ -129,10 +129,11 @@ def _run_command(
             capture_output: Whether to capture output.
                 This can be used when not wanting to suppress output but still needing
                 to process the contents. The output will be buffered and returned as a
-                string. If ``suppress_output`` is ``True``, this will be ignored.
+                string. If ``suppress_output`` is :data`True`, this will be ignored.
             env: Environment variables.
-            suppress_output: If ``True``, the output of the subprocess written
-                to ``sys.stdout`` and ``sys.stderr`` will be captured and
+            suppress_output: Whether to suppress output.
+                If :data`True`, the output of the subprocess written
+                to :data:`sys.stdout` and :data:`sys.stderr` will be captured and
                 returned as a string instead of being being written directly.
             timeout: Number of seconds to wait before terminating the child process.
                 Internally passed on to :meth:`~subprocess.Popen.communicate`.