From cd4c44069f43894e504ee5e022dd5c4db9a14c96 Mon Sep 17 00:00:00 2001 From: Josh Lay Date: Tue, 25 Apr 2023 21:41:16 -0500 Subject: [PATCH] docs: disable problematic sphinx conf.py linting --- docs/source/conf.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 37dafdb..c94fee8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,3 +1,11 @@ +""" +Configuration file for the Sphinx documentation builder. + +For the full list of built-in configuration values, see the documentation: +https://www.sphinx-doc.org/en/master/usage/configuration.html +""" +# 'fix' linting; sphinx doesn't apply +# pylint: disable=invalid-name,redefined-builtin import os import sys @@ -9,11 +17,6 @@ import sys # sys.path.insert(0, os.path.abspath(os.path.join("..", "..", "src"))) -# Configuration file for the Sphinx documentation builder. -# -# For the full list of built-in configuration values, see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information