feat: add pylint for docs (#202)

* add pylint for docs

* linting

* docstring to comment

* remove repated comment

Author: hughhm

.pre-commit-config.yaml

@@ -1,7 +1,5 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
-# skip all the files in docs/
-exclude: 'docs/'
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v3.4.0

docs/_static/logo.svg

@@ -1,9 +1,8 @@
-.. _{{fullname}}:                                  
-                                                   
-{{ name }}                                         
-{{ underline }}                                    
-                                                   
-.. currentmodule:: {{ module }}                    
-                                                   
-.. autoattribute:: {{ module}}.{{ objname }}          
+.. _{{fullname}}:
 
+{{ name }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. autoattribute:: {{ module}}.{{ objname }}

docs/_templates/autosummary/attribute.rst

@@ -1,9 +1,8 @@
-.. _{{fullname}}:                                   
-                                                    
-{{ name }}                                          
-{{ underline }}                                     
-                                                    
-.. currentmodule:: {{ module }}                     
-                                                    
-.. automethod:: {{ module}}.{{ objname }}                     
+.. _{{fullname}}:
 
+{{ name }}
+{{ underline }}
+
+.. currentmodule:: {{ module }}
+
+.. automethod:: {{ module}}.{{ objname }}

docs/_templates/autosummary/method.rst

@@ -1,4 +1,4 @@
 {%- extends "sphinx_rtd_theme/breadcrumbs.html" %}
 
 {% block breadcrumbs_aside %}
-{% endblock %}
+{% endblock %}

docs/_templates/breadcrumbs.html

@@ -6,4 +6,3 @@
     :recursive:
 
     qctrlopencontrols
-

docs/autosummary.rst

@@ -1,15 +1,31 @@
-# pylint: disable=invalid-name
+# Copyright 2021 Q-CTRL. All rights reserved.
+#
+# Licensed under the Q-CTRL Terms of service (the "License"). Unauthorized
+# copying or use of this file, via any medium, is strictly prohibited.
+# Proprietary and confidential. You may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+#      https://q-ctrl.com/terms
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS. See the
+# License for the specific language.
+# pylint:disable=invalid-name
+
 """
 Configuration file for the Sphinx documentation builder.
-"""  # This file only contains a selection of the most common options. For a full
-# list see the documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html
+"""
+
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 # -- Path setup --------------------------------------------------------------
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#
+
 import datetime
 import inspect
 import os

docs/conf.py

@@ -15,7 +15,3 @@ The Q-CTRL Open Controls Python package provides a comprehensive library of publ
   :maxdepth: 1
 
   API Reference <qctrlopencontrols.rst>
-
-
-
-

docs/index.rst

@@ -43,7 +43,7 @@ cloned using
 Once the clone is complete, you have two options:
 
 
-#. 
+#.
    Using setup.py
 
    .. code-block:: shell
@@ -54,7 +54,7 @@ Once the clone is complete, you have two options:
    **Note:** We recommend installing using ``develop`` to point your installation
    at the source code in the directory where you cloned the repository.
 
-#. 
+#.
    Using Poetry
 
    Follow the instructions from the