diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0cc5e66e..54e876f3 100644 --- a/.pre-commit-config.yaml +++ b/.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 diff --git a/docs/_static/logo.svg b/docs/_static/logo.svg index 399d4027..ffa767fa 100644 --- a/docs/_static/logo.svg +++ b/docs/_static/logo.svg @@ -1 +1 @@ -Primary_Horizontal \ No newline at end of file +Primary_Horizontal diff --git a/docs/_templates/autosummary/attribute.rst b/docs/_templates/autosummary/attribute.rst index 37500c8c..16620eb6 100644 --- a/docs/_templates/autosummary/attribute.rst +++ b/docs/_templates/autosummary/attribute.rst @@ -1,9 +1,8 @@ -.. _{{fullname}}: - -{{ name }} -{{ underline }} - -.. currentmodule:: {{ module }} - -.. autoattribute:: {{ module}}.{{ objname }} +.. _{{fullname}}: +{{ name }} +{{ underline }} + +.. currentmodule:: {{ module }} + +.. autoattribute:: {{ module}}.{{ objname }} diff --git a/docs/_templates/autosummary/method.rst b/docs/_templates/autosummary/method.rst index b6316c89..900c690f 100644 --- a/docs/_templates/autosummary/method.rst +++ b/docs/_templates/autosummary/method.rst @@ -1,9 +1,8 @@ -.. _{{fullname}}: - -{{ name }} -{{ underline }} - -.. currentmodule:: {{ module }} - -.. automethod:: {{ module}}.{{ objname }} +.. _{{fullname}}: +{{ name }} +{{ underline }} + +.. currentmodule:: {{ module }} + +.. automethod:: {{ module}}.{{ objname }} diff --git a/docs/_templates/breadcrumbs.html b/docs/_templates/breadcrumbs.html index 339f008b..4ecb013f 100644 --- a/docs/_templates/breadcrumbs.html +++ b/docs/_templates/breadcrumbs.html @@ -1,4 +1,4 @@ {%- extends "sphinx_rtd_theme/breadcrumbs.html" %} {% block breadcrumbs_aside %} -{% endblock %} \ No newline at end of file +{% endblock %} diff --git a/docs/autosummary.rst b/docs/autosummary.rst index 613a9b2d..85acf8f2 100644 --- a/docs/autosummary.rst +++ b/docs/autosummary.rst @@ -6,4 +6,3 @@ :recursive: qctrlopencontrols - diff --git a/docs/conf.py b/docs/conf.py index 475fa1a1..7cea982c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/index.rst b/docs/index.rst index d6d3ffab..ee97b302 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,7 +15,3 @@ The Q-CTRL Open Controls Python package provides a comprehensive library of publ :maxdepth: 1 API Reference - - - - diff --git a/docs/installation.rst b/docs/installation.rst index a01650b0..aca8c094 100644 --- a/docs/installation.rst +++ b/docs/installation.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