From a43b37e3faef511c199cbd2e15e6fb646cdb0845 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 12:34:53 -0500 Subject: [PATCH 01/32] Rename README.md to README.rst --- README.md => README.rst | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.md => README.rst (100%) diff --git a/README.md b/README.rst similarity index 100% rename from README.md rename to README.rst From e3e3eb705ab58880b61bd7bd6a4bb702d423ac20 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 12:39:25 -0500 Subject: [PATCH 02/32] pyproject.toml --- pyproject.toml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..14a2dda --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,8 @@ +[build-system] +requires = ["flit_core >=3.2,<4"] +build-backend = "flit_core.buildapi" + +[project] +name = "lumache" +authors = [{name = "Graziella", email = "graziella@lumache"}] +dynamic = ["version", "description"] From 80fa791b09e04c24c43da83e53cfde09fedd062e Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 12:39:51 -0500 Subject: [PATCH 03/32] lumache.py --- lumache.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 lumache.py diff --git a/lumache.py b/lumache.py new file mode 100644 index 0000000..304631e --- /dev/null +++ b/lumache.py @@ -0,0 +1,34 @@ +""" +Lumache - Python library for cooks and food lovers. + +This is a Python docstring, we can use reStructuredText syntax here! + +.. code-block:: python + + # Import lumache + import lumache + + # Call its only function + get_random_ingredients(kind=["cheeses"]) +""" + +__version__ = "0.1.0" + + +class InvalidKindError(Exception): + """Raised if the kind is invalid.""" + + pass + + +def get_random_ingredients(kind=None): + """ + Return a list of random ingredients as strings. + + :param kind: Optional "kind" of ingredients. + :type kind: list[str] or None + :raise lumache.InvalidKindError: If the kind is invalid. + :return: The ingredients list. + :rtype: list[str] + """ + return ["shells", "gorgonzola", "parsley"] From 184b891dc96ad45382a3f320c341ed8da4ac8b81 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 12:42:08 -0500 Subject: [PATCH 04/32] .readthedocs.yml --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index fdab351..c3b6110 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,4 +1,4 @@ -# Reference: https://docs.readthedocs.io/en/latest/yaml-config.html +Reference: https://docs.readthedocs.io/en/latest/yaml-config.html build: image: latest From 60f984f204841d6da255a1d7dc0dea6a4dcd2b2f Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:38:31 -0500 Subject: [PATCH 05/32] Update .readthedocs.yml --- .readthedocs.yml | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index c3b6110..c8d8991 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,11 +1,15 @@ -Reference: https://docs.readthedocs.io/en/latest/yaml-config.html +version: 2 build: - image: latest + os: "ubuntu-22.04" + tools: + python: "3.12" -# Possible options: htmlzip, pdf, epub -# Disable (single) htmlzip as it's way too big to be useful, -# and leads to excessive memory usage on build -# Disable epub and pdf for now to speed up builds -# formats: -# - pdf +# Build from the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Explicitly set the version of Python and its requirements +python: + install: + - requirements: docs/requirements.txt From 811818b03c1adf2f139b8ed48bfef3190de508b2 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:39:57 -0500 Subject: [PATCH 06/32] Delete lumache.py --- lumache.py | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 lumache.py diff --git a/lumache.py b/lumache.py deleted file mode 100644 index 304631e..0000000 --- a/lumache.py +++ /dev/null @@ -1,34 +0,0 @@ -""" -Lumache - Python library for cooks and food lovers. - -This is a Python docstring, we can use reStructuredText syntax here! - -.. code-block:: python - - # Import lumache - import lumache - - # Call its only function - get_random_ingredients(kind=["cheeses"]) -""" - -__version__ = "0.1.0" - - -class InvalidKindError(Exception): - """Raised if the kind is invalid.""" - - pass - - -def get_random_ingredients(kind=None): - """ - Return a list of random ingredients as strings. - - :param kind: Optional "kind" of ingredients. - :type kind: list[str] or None - :raise lumache.InvalidKindError: If the kind is invalid. - :return: The ingredients list. - :rtype: list[str] - """ - return ["shells", "gorgonzola", "parsley"] From e0f5e2a71358bad28fd9b545a9f73b92193f2e56 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:40:06 -0500 Subject: [PATCH 07/32] Delete pyproject.toml --- pyproject.toml | 8 -------- 1 file changed, 8 deletions(-) delete mode 100644 pyproject.toml diff --git a/pyproject.toml b/pyproject.toml deleted file mode 100644 index 14a2dda..0000000 --- a/pyproject.toml +++ /dev/null @@ -1,8 +0,0 @@ -[build-system] -requires = ["flit_core >=3.2,<4"] -build-backend = "flit_core.buildapi" - -[project] -name = "lumache" -authors = [{name = "Graziella", email = "graziella@lumache"}] -dynamic = ["version", "description"] From 611255a5477e609d9410e34dbe6cc1c2d1773b7f Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:41:36 -0500 Subject: [PATCH 08/32] Rename README.rst to README.md --- README.rst => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README.rst => README.md (100%) diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md From 8cbb39bc3b9d8cbee2fc09f11b415f801e972bb2 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 14:00:32 -0500 Subject: [PATCH 09/32] Update .readthedocs.yml --- .readthedocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index c8d8991..d79b29c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -10,6 +10,6 @@ sphinx: configuration: docs/conf.py # Explicitly set the version of Python and its requirements -python: - install: - - requirements: docs/requirements.txt +#python: + #install: + #- requirements: docs/requirements.txt From cafc7de4f6e9869f0eb424ed7e0aa5d4c877dd12 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:12:31 -0500 Subject: [PATCH 10/32] Create conf.py --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/conf.py diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1 @@ + From a7090f2d287cdafbf25b57a0e4972f64f6f4797c Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:14:21 -0500 Subject: [PATCH 11/32] Update conf.py --- docs/conf.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8b13789..1e1e0d8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1 +1,11 @@ +version: 2 +python: + #install: + #requirements: docs/requirements.txt + #method: pip + # path: . + # extra_requirements: + # - docs + - method: pip + path: another/package From ccd2f1342bec642facb3b1547866a9dc8321d7f6 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:17:25 -0500 Subject: [PATCH 12/32] Update conf.py --- docs/conf.py | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1e1e0d8..5bfd401 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,6 @@ version: 2 -python: - #install: - #requirements: docs/requirements.txt - #method: pip - # path: . - # extra_requirements: - # - docs - - method: pip - path: another/package +sphinx: + builder: html + configuration: conf.py + fail_on_warning: true From 691647258d68b576fda430c08c36b875de01d7e8 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:22:00 -0500 Subject: [PATCH 13/32] Update .readthedocs.yml --- .readthedocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index d79b29c..8ddda4f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,8 +6,8 @@ build: python: "3.12" # Build from the docs/ directory with Sphinx -sphinx: - configuration: docs/conf.py +#sphinx: + #configuration: docs/conf.py # Explicitly set the version of Python and its requirements #python: From 5cb82077c52c0f16e9ebd511f064a9a8638a3098 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:32:50 -0500 Subject: [PATCH 14/32] Update conf.py --- docs/conf.py | 126 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 121 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 5bfd401..8b4d393 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,122 @@ -version: 2 +{\rtf1\ansi\ansicpg1252\cocoartf2758 +\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fnil\fcharset0 Menlo-Regular;} +{\colortbl;\red255\green255\blue255;\red89\green138\blue67;\red0\green0\blue0;\red193\green193\blue193; +\red140\green211\blue254;\red202\green202\blue202;\red194\green126\blue101;\red205\green173\blue106;\red70\green137\blue204; +\red196\green83\blue86;\red167\green197\blue152;} +{\*\expandedcolortbl;;\cssrgb\c41569\c60000\c33333;\csgray\c0\c0;\cssrgb\c80000\c80000\c80000; +\cssrgb\c61176\c86275\c99608;\cssrgb\c83137\c83137\c83137;\cssrgb\c80784\c56863\c47059;\cssrgb\c84314\c72941\c49020;\cssrgb\c33725\c61176\c83922; +\cssrgb\c81961\c41176\c41176;\cssrgb\c70980\c80784\c65882;} +\margl1440\margr1440\vieww11520\viewh8400\viewkind0 +\deftab720 +\pard\pardeftab720\partightenfactor0 -sphinx: - builder: html - configuration: conf.py - fail_on_warning: true +\f0\fs24 \cf2 \cb3 \expnd0\expndtw0\kerning0 +\outl0\strokewidth0 \strokec2 # Configuration file for the Sphinx documentation builder.\cf4 \strokec4 \ +\cf2 \strokec2 #\cf4 \strokec4 \ +\cf2 \strokec2 # For the full list of built-in configuration values, see the documentation:\cf4 \strokec4 \ +\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html\cf4 \strokec4 \ +\ +\cf2 \strokec2 # -- Project information -----------------------------------------------------\cf4 \strokec4 \ +\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 project\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'CIS Controls Assessment Specification'\cf4 \strokec4 \ +\cf5 \strokec5 copyright\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '2023, Center for Internet Security'\cf4 \strokec4 \ +\cf5 \strokec5 author\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'Center for Internet Security'\cf4 \strokec4 \ +\cf5 \strokec5 release\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '0.1'\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # -- General configuration ---------------------------------------------------\cf4 \strokec4 \ +\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 extensions\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ +# \cf7 \strokec7 'sphinx.ext.imgconverter'\cf4 \strokec4 ,\ +# \cf7 \strokec7 'myst_parser'\cf4 \strokec4 ,\ + \cf7 \strokec7 'sphinx_last_updated_by_git'\cf4 \strokec4 ,\ +# \cf7 \strokec7 'sphinx.ext.intersphinx'\cf4 \strokec4 ,\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # 'sphinxcontrib.video',\cf4 \strokec4 \ +# \cf7 \strokec7 'linuxdoc.rstFlatTable'\cf4 \strokec4 ,\ + \cf7 \strokec7 'sphinx.ext.viewcode'\cf4 \strokec4 ,\ +\cf2 \strokec2 # 'sphinx_tabs.tabs',\cf4 \strokec4 \ +\cf2 \strokec2 # 'sphinx-prompt',\cf4 \strokec4 \ +# \cf7 \strokec7 'sphinx_toolbox.collapse'\cf4 \strokec4 ,\ +\cf2 \strokec2 # 'sphinx_toolbox.more_autosummary',\cf4 \strokec4 \ +]\ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 templates_path\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 '_templates'\cf4 \strokec4 ]\ +\cf5 \strokec5 exclude_patterns\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 []\ +\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # -- Options for intersphinx -------------------------------------------------\cf4 \strokec4 \ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 #intersphinx_mapping\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ +#\}\ +\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # We recommend adding the following config value.\cf4 \strokec4 \ +\cf2 \strokec2 # Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings.\cf4 \strokec4 \ +\cf2 \strokec2 # This behavior has unintended side-effects, namely that documentations local references can\cf4 \strokec4 \ +\cf2 \strokec2 # suddenly resolve to an external location.\cf4 \strokec4 \ +\cf2 \strokec2 # See also:\cf4 \strokec4 \ +\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes\cf4 \strokec4 \ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 intersphinx_disabled_reftypes\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 "*"\cf4 \strokec4 ]\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # -- Options for HTML output -------------------------------------------------\cf4 \strokec4 \ +\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 html_theme\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'furo'\cf4 \strokec4 \ +\cf5 \strokec5 html_static_path\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 '_static'\cf4 \strokec4 ]\ +\ +\cf5 \strokec5 html_short_title\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'EI-ISAC Procurement Guide'\cf4 \strokec4 \ +\cf5 \strokec5 html_title\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'EI-ISAC\cf8 \strokec8 \\'\cf7 \strokec7 s Guide to Election Technology Procurements'\cf4 \strokec4 \ +\ +\cf5 \strokec5 html_theme_options\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ + \cf7 \strokec7 'light_logo'\cf4 \strokec4 : \cf7 \strokec7 'EI-ISAC-Logo-Stack-2Spot-RGB.png'\cf4 \strokec4 ,\ + \cf7 \strokec7 'dark_logo'\cf4 \strokec4 : \cf7 \strokec7 'EI-ISAC-Logo-Stack-Reverse-2Spot-RGB.png'\cf4 \strokec4 ,\ + \cf7 \strokec7 "light_css_variables"\cf4 \strokec4 : \{\ + \cf7 \strokec7 "font-stack"\cf4 \strokec4 : \cf7 \strokec7 "acumin-pro, sans-serif"\cf4 \strokec4 ,\ + \cf7 \strokec7 "font-stack--monospace"\cf4 \strokec4 : \cf7 \strokec7 "Courier, monospace"\cf4 \strokec4 ,\ + \},\ +\}\ +\ +\cf5 \strokec5 html_css_files\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ + \cf7 \strokec7 'https://use.typekit.net/rcq0ndn.css'\cf4 \strokec4 ,\ +]\ +\ +\cf5 \strokec5 html_favicon\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '_static/favicon.ico'\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # -- Options for MyST --------------------------------------------------------\cf4 \strokec4 \ +\cf2 \strokec2 # https://myst-parser.readthedocs.io/en/stable/configuration.html\cf4 \strokec4 \ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 #latex_elements\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ +\pard\pardeftab720\partightenfactor0 +\cf2 \strokec2 # The paper size ('letterpaper' or 'a4paper').\cf4 \strokec4 \ +# \cf7 \strokec7 'papersize'\cf4 \strokec4 : \cf7 \strokec7 'letterpaper'\cf4 \strokec4 ,\ +\ +\cf2 \strokec2 # The font size ('10pt', '11pt' or '12pt').\cf4 \strokec4 \ +# \cf7 \strokec7 'pointsize'\cf4 \strokec4 : \cf7 \strokec7 '11pt'\cf4 \strokec4 ,\ +\ +\cf2 \strokec2 # Additional stuff for the LaTeX preamble.\cf4 \strokec4 \ +# \cf7 \strokec7 'preamble'\cf4 \strokec4 : \cf9 \strokec9 r\cf10 \strokec10 '''\cf4 \strokec4 \ +\pard\pardeftab720\partightenfactor0 +\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\{charter\}\cf4 \strokec4 \ +\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\cf7 \strokec7 [\cf10 \strokec10 defaultsans\cf7 \strokec7 ]\cf10 \strokec10 \{lato\}\cf4 \strokec4 \ +\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\{inconsolata\}\cf4 \strokec4 \ +\cf10 \strokec10 # '''\cf4 \strokec4 ,\ +#\}\ +\ +\pard\pardeftab720\partightenfactor0 +\cf5 \strokec5 myst_enable_extensions\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ + \cf7 \strokec7 'colon_fence'\cf4 \strokec4 ,\ +]\ +\ +\cf5 \strokec5 myst_heading_anchors\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf11 \strokec11 5\cf4 \strokec4 \ +\ +} From 5677aefffd16f3fbc7639011d637e5e1537fb1ba Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:38:21 -0500 Subject: [PATCH 15/32] Update conf.py --- docs/conf.py | 212 ++++++++++++++++++++++----------------------------- 1 file changed, 91 insertions(+), 121 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 8b4d393..1882c57 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,122 +1,92 @@ -{\rtf1\ansi\ansicpg1252\cocoartf2758 -\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fnil\fcharset0 Menlo-Regular;} -{\colortbl;\red255\green255\blue255;\red89\green138\blue67;\red0\green0\blue0;\red193\green193\blue193; -\red140\green211\blue254;\red202\green202\blue202;\red194\green126\blue101;\red205\green173\blue106;\red70\green137\blue204; -\red196\green83\blue86;\red167\green197\blue152;} -{\*\expandedcolortbl;;\cssrgb\c41569\c60000\c33333;\csgray\c0\c0;\cssrgb\c80000\c80000\c80000; -\cssrgb\c61176\c86275\c99608;\cssrgb\c83137\c83137\c83137;\cssrgb\c80784\c56863\c47059;\cssrgb\c84314\c72941\c49020;\cssrgb\c33725\c61176\c83922; -\cssrgb\c81961\c41176\c41176;\cssrgb\c70980\c80784\c65882;} -\margl1440\margr1440\vieww11520\viewh8400\viewkind0 -\deftab720 -\pard\pardeftab720\partightenfactor0 - -\f0\fs24 \cf2 \cb3 \expnd0\expndtw0\kerning0 -\outl0\strokewidth0 \strokec2 # Configuration file for the Sphinx documentation builder.\cf4 \strokec4 \ -\cf2 \strokec2 #\cf4 \strokec4 \ -\cf2 \strokec2 # For the full list of built-in configuration values, see the documentation:\cf4 \strokec4 \ -\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html\cf4 \strokec4 \ -\ -\cf2 \strokec2 # -- Project information -----------------------------------------------------\cf4 \strokec4 \ -\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 project\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'CIS Controls Assessment Specification'\cf4 \strokec4 \ -\cf5 \strokec5 copyright\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '2023, Center for Internet Security'\cf4 \strokec4 \ -\cf5 \strokec5 author\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'Center for Internet Security'\cf4 \strokec4 \ -\cf5 \strokec5 release\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '0.1'\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # -- General configuration ---------------------------------------------------\cf4 \strokec4 \ -\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 extensions\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ -# \cf7 \strokec7 'sphinx.ext.imgconverter'\cf4 \strokec4 ,\ -# \cf7 \strokec7 'myst_parser'\cf4 \strokec4 ,\ - \cf7 \strokec7 'sphinx_last_updated_by_git'\cf4 \strokec4 ,\ -# \cf7 \strokec7 'sphinx.ext.intersphinx'\cf4 \strokec4 ,\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # 'sphinxcontrib.video',\cf4 \strokec4 \ -# \cf7 \strokec7 'linuxdoc.rstFlatTable'\cf4 \strokec4 ,\ - \cf7 \strokec7 'sphinx.ext.viewcode'\cf4 \strokec4 ,\ -\cf2 \strokec2 # 'sphinx_tabs.tabs',\cf4 \strokec4 \ -\cf2 \strokec2 # 'sphinx-prompt',\cf4 \strokec4 \ -# \cf7 \strokec7 'sphinx_toolbox.collapse'\cf4 \strokec4 ,\ -\cf2 \strokec2 # 'sphinx_toolbox.more_autosummary',\cf4 \strokec4 \ -]\ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 templates_path\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 '_templates'\cf4 \strokec4 ]\ -\cf5 \strokec5 exclude_patterns\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 []\ -\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # -- Options for intersphinx -------------------------------------------------\cf4 \strokec4 \ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 #intersphinx_mapping\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ -#\}\ -\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # We recommend adding the following config value.\cf4 \strokec4 \ -\cf2 \strokec2 # Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings.\cf4 \strokec4 \ -\cf2 \strokec2 # This behavior has unintended side-effects, namely that documentations local references can\cf4 \strokec4 \ -\cf2 \strokec2 # suddenly resolve to an external location.\cf4 \strokec4 \ -\cf2 \strokec2 # See also:\cf4 \strokec4 \ -\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes\cf4 \strokec4 \ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 intersphinx_disabled_reftypes\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 "*"\cf4 \strokec4 ]\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # -- Options for HTML output -------------------------------------------------\cf4 \strokec4 \ -\cf2 \strokec2 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 html_theme\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'furo'\cf4 \strokec4 \ -\cf5 \strokec5 html_static_path\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\cf7 \strokec7 '_static'\cf4 \strokec4 ]\ -\ -\cf5 \strokec5 html_short_title\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'EI-ISAC Procurement Guide'\cf4 \strokec4 \ -\cf5 \strokec5 html_title\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 'EI-ISAC\cf8 \strokec8 \\'\cf7 \strokec7 s Guide to Election Technology Procurements'\cf4 \strokec4 \ -\ -\cf5 \strokec5 html_theme_options\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ - \cf7 \strokec7 'light_logo'\cf4 \strokec4 : \cf7 \strokec7 'EI-ISAC-Logo-Stack-2Spot-RGB.png'\cf4 \strokec4 ,\ - \cf7 \strokec7 'dark_logo'\cf4 \strokec4 : \cf7 \strokec7 'EI-ISAC-Logo-Stack-Reverse-2Spot-RGB.png'\cf4 \strokec4 ,\ - \cf7 \strokec7 "light_css_variables"\cf4 \strokec4 : \{\ - \cf7 \strokec7 "font-stack"\cf4 \strokec4 : \cf7 \strokec7 "acumin-pro, sans-serif"\cf4 \strokec4 ,\ - \cf7 \strokec7 "font-stack--monospace"\cf4 \strokec4 : \cf7 \strokec7 "Courier, monospace"\cf4 \strokec4 ,\ - \},\ -\}\ -\ -\cf5 \strokec5 html_css_files\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ - \cf7 \strokec7 'https://use.typekit.net/rcq0ndn.css'\cf4 \strokec4 ,\ -]\ -\ -\cf5 \strokec5 html_favicon\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf7 \strokec7 '_static/favicon.ico'\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # -- Options for MyST --------------------------------------------------------\cf4 \strokec4 \ -\cf2 \strokec2 # https://myst-parser.readthedocs.io/en/stable/configuration.html\cf4 \strokec4 \ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 #latex_elements\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \{\ -\pard\pardeftab720\partightenfactor0 -\cf2 \strokec2 # The paper size ('letterpaper' or 'a4paper').\cf4 \strokec4 \ -# \cf7 \strokec7 'papersize'\cf4 \strokec4 : \cf7 \strokec7 'letterpaper'\cf4 \strokec4 ,\ -\ -\cf2 \strokec2 # The font size ('10pt', '11pt' or '12pt').\cf4 \strokec4 \ -# \cf7 \strokec7 'pointsize'\cf4 \strokec4 : \cf7 \strokec7 '11pt'\cf4 \strokec4 ,\ -\ -\cf2 \strokec2 # Additional stuff for the LaTeX preamble.\cf4 \strokec4 \ -# \cf7 \strokec7 'preamble'\cf4 \strokec4 : \cf9 \strokec9 r\cf10 \strokec10 '''\cf4 \strokec4 \ -\pard\pardeftab720\partightenfactor0 -\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\{charter\}\cf4 \strokec4 \ -\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\cf7 \strokec7 [\cf10 \strokec10 defaultsans\cf7 \strokec7 ]\cf10 \strokec10 \{lato\}\cf4 \strokec4 \ -\cf10 \strokec10 # \cf8 \strokec8 \\u\cf10 \strokec10 sepackage\{inconsolata\}\cf4 \strokec4 \ -\cf10 \strokec10 # '''\cf4 \strokec4 ,\ -#\}\ -\ -\pard\pardeftab720\partightenfactor0 -\cf5 \strokec5 myst_enable_extensions\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 [\ - \cf7 \strokec7 'colon_fence'\cf4 \strokec4 ,\ -]\ -\ -\cf5 \strokec5 myst_heading_anchors\cf4 \strokec4 \cf6 \strokec6 =\cf4 \strokec4 \cf11 \strokec11 5\cf4 \strokec4 \ -\ +# 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 + +project = 'ControlsAssessmentSpecification' +copyright = '2023, Center for Internet Security' +author = 'Center for Internet Security' +release = '0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ +# 'sphinx.ext.imgconverter', +# 'myst_parser', + 'sphinx_last_updated_by_git', +# 'sphinx.ext.intersphinx', +# 'sphinxcontrib.video', +# 'linuxdoc.rstFlatTable', + 'sphinx.ext.viewcode', +# 'sphinx_tabs.tabs', +# 'sphinx-prompt', +# 'sphinx_toolbox.collapse', +# 'sphinx_toolbox.more_autosummary', +] + +templates_path = ['_templates'] +exclude_patterns = [] + +# -- Options for intersphinx ------------------------------------------------- +#intersphinx_mapping = { +#} + +# We recommend adding the following config value. +# Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings. +# This behavior has unintended side-effects, namely that documentations local references can +# suddenly resolve to an external location. +# See also: +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes +intersphinx_disabled_reftypes = ["*"] +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] + +html_short_title = 'EI-ISAC Procurement Guide' +html_title = 'EI-ISAC\'s Guide to Election Technology Procurements' + +html_theme_options = { + 'light_logo': 'EI-ISAC-Logo-Stack-2Spot-RGB.png', + 'dark_logo': 'EI-ISAC-Logo-Stack-Reverse-2Spot-RGB.png', + "light_css_variables": { + "font-stack": "acumin-pro, sans-serif", + "font-stack--monospace": "Courier, monospace", + }, } + +html_css_files = [ + 'https://use.typekit.net/rcq0ndn.css', +] + +html_favicon = '_static/favicon.ico' + +# -- Options for MyST -------------------------------------------------------- +# https://myst-parser.readthedocs.io/en/stable/configuration.html + +#latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +# 'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +# 'pointsize': '11pt', + +# Additional stuff for the LaTeX preamble. +# 'preamble': r''' +# \usepackage{charter} +# \usepackage[defaultsans]{lato} +# \usepackage{inconsolata} +# ''', +#} + +myst_enable_extensions = [ + 'colon_fence', +] + +myst_heading_anchors = 5 + From 1b20568ee93dfa7e72215091feb9c67edf3cea35 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:48:53 -0500 Subject: [PATCH 16/32] Update .readthedocs.yml --- .readthedocs.yml | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 8ddda4f..dd2aa46 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,15 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required version: 2 +# Set the OS, Python version and other tools you might need build: - os: "ubuntu-22.04" + os: ubuntu-22.04 tools: python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true -# Build from the docs/ directory with Sphinx -#sphinx: - #configuration: docs/conf.py +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub -# Explicitly set the version of Python and its requirements -#python: - #install: - #- requirements: docs/requirements.txt +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt From 67aa52fe3827c4eb8e074fdf84b416018c324e91 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:51:51 -0500 Subject: [PATCH 17/32] Update .gitignore --- .gitignore | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.gitignore b/.gitignore index ae6f328..139597f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,2 @@ -docs/ -_build/ -conf.py -_tmp/ From 6f6a68c255d543fbe33d94cc95e8cad5689a0fd1 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 15:55:18 -0500 Subject: [PATCH 18/32] Update .gitignore --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 139597f..10726cc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,6 @@ +docs/ +_build/ +conf.py +_tmp/ From 15bc5991188f9c8187afb9751b48761d6c7b39ad Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:12:20 -0500 Subject: [PATCH 19/32] Update .readthedocs.yml --- .readthedocs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index dd2aa46..bff923c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: docs/requirements.txt From c481fdea1b53d7bc6dee5e99ee7b388f20b9e557 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:15:28 -0500 Subject: [PATCH 20/32] Create requirements.txt --- docs/requirements.txt | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..5e4dcc3 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +#requirments.txt + +sphinx_last_update_by_git From 877a18f14df18aff3b42c4f0068970748e124430 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:18:40 -0500 Subject: [PATCH 21/32] Update requirements.txt --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 5e4dcc3..cdb42c6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,5 @@ #requirments.txt +sphinx==latest + sphinx_last_update_by_git From b443b2aa365a051db67d44f9f1645f0e6fb28ff2 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:20:00 -0500 Subject: [PATCH 22/32] Update requirements.txt --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index cdb42c6..f666a12 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ #requirments.txt -sphinx==latest +sphinx==4.4.0 sphinx_last_update_by_git From a07379e9a346d3c29f2c17b6c633ce506fa0e41f Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:21:56 -0500 Subject: [PATCH 23/32] Update requirements.txt --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index f666a12..210aa3a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ #requirments.txt -sphinx==4.4.0 +sphinx==7.2.6 sphinx_last_update_by_git From 425ee5d9006be4162ace6ddc76f87e5bb9740d84 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:23:52 -0500 Subject: [PATCH 24/32] Update requirements.txt --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 210aa3a..2019fb0 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ sphinx==7.2.6 -sphinx_last_update_by_git +#sphinx_last_update_by_git From 16a87638f45544d09fff26c692f11406c3dde00d Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:27:57 -0500 Subject: [PATCH 25/32] Update requirements.txt --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 2019fb0..f626a16 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ #requirments.txt -sphinx==7.2.6 +sphinx==2.0.1 #sphinx_last_update_by_git From 5b5b88319996364c3e00c4c272e76998ee5cae9a Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:29:29 -0500 Subject: [PATCH 26/32] Update requirements.txt --- docs/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index f626a16..d4abfcc 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ #requirments.txt -sphinx==2.0.1 +sphinx==2.4.1 -#sphinx_last_update_by_git +sphinx_last_update_by_git From 985a891c39372b9f58a05888bbbe672947e09a42 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:30:41 -0500 Subject: [PATCH 27/32] Update requirements.txt --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d4abfcc..71c2314 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,4 @@ sphinx==2.4.1 -sphinx_last_update_by_git +#sphinx_last_update_by_git From bce09d3a83fcd9fb32ca762ba8dd0097b34abaa4 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:35:19 -0500 Subject: [PATCH 28/32] Update conf.py --- docs/conf.py | 103 ++++++--------------------------------------------- 1 file changed, 11 insertions(+), 92 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1882c57..e7380d4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,92 +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 - -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - -project = 'ControlsAssessmentSpecification' -copyright = '2023, Center for Internet Security' -author = 'Center for Internet Security' -release = '0.1' - -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - -extensions = [ -# 'sphinx.ext.imgconverter', -# 'myst_parser', - 'sphinx_last_updated_by_git', -# 'sphinx.ext.intersphinx', -# 'sphinxcontrib.video', -# 'linuxdoc.rstFlatTable', - 'sphinx.ext.viewcode', -# 'sphinx_tabs.tabs', -# 'sphinx-prompt', -# 'sphinx_toolbox.collapse', -# 'sphinx_toolbox.more_autosummary', -] - -templates_path = ['_templates'] -exclude_patterns = [] - -# -- Options for intersphinx ------------------------------------------------- -#intersphinx_mapping = { -#} - -# We recommend adding the following config value. -# Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings. -# This behavior has unintended side-effects, namely that documentations local references can -# suddenly resolve to an external location. -# See also: -# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes -intersphinx_disabled_reftypes = ["*"] -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output - -html_theme = 'furo' -html_static_path = ['_static'] - -html_short_title = 'EI-ISAC Procurement Guide' -html_title = 'EI-ISAC\'s Guide to Election Technology Procurements' - -html_theme_options = { - 'light_logo': 'EI-ISAC-Logo-Stack-2Spot-RGB.png', - 'dark_logo': 'EI-ISAC-Logo-Stack-Reverse-2Spot-RGB.png', - "light_css_variables": { - "font-stack": "acumin-pro, sans-serif", - "font-stack--monospace": "Courier, monospace", - }, -} - -html_css_files = [ - 'https://use.typekit.net/rcq0ndn.css', -] - -html_favicon = '_static/favicon.ico' - -# -- Options for MyST -------------------------------------------------------- -# https://myst-parser.readthedocs.io/en/stable/configuration.html - -#latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -# 'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -# 'pointsize': '11pt', - -# Additional stuff for the LaTeX preamble. -# 'preamble': r''' -# \usepackage{charter} -# \usepackage[defaultsans]{lato} -# \usepackage{inconsolata} -# ''', -#} - -myst_enable_extensions = [ - 'colon_fence', -] - -myst_heading_anchors = 5 - +version: 2 + +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: + - docs + - method: pip + path: another/package From 89051756e14f4ea8680c79efcf60872df72ec863 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:40:11 -0500 Subject: [PATCH 29/32] Update conf.py --- docs/conf.py | 103 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 92 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e7380d4..cb71169 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,92 @@ -version: 2 - -python: - install: - - requirements: docs/requirements.txt - - method: pip - path: . - extra_requirements: - - docs - - method: pip - path: another/package +# 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 + +project = 'CIS Controls Assessment Specification' +copyright = '2023, Center for Internet Security' +author = 'Center for Internet Security' +release = '0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ +# 'sphinx.ext.imgconverter', +# 'myst_parser', + 'sphinx_last_updated_by_git', +# 'sphinx.ext.intersphinx', +# 'sphinxcontrib.video', +# 'linuxdoc.rstFlatTable', + 'sphinx.ext.viewcode', +# 'sphinx_tabs.tabs', +# 'sphinx-prompt', +# 'sphinx_toolbox.collapse', +# 'sphinx_toolbox.more_autosummary', +] + +templates_path = ['_templates'] +exclude_patterns = [] + +# -- Options for intersphinx ------------------------------------------------- +#intersphinx_mapping = { +#} + +# We recommend adding the following config value. +# Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings. +# This behavior has unintended side-effects, namely that documentations local references can +# suddenly resolve to an external location. +# See also: +# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes +intersphinx_disabled_reftypes = ["*"] +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'furo' +html_static_path = ['_static'] + +html_short_title = 'CIS Controls Assessment Specification' +html_title = 'CIS Controls Assessment Specification' + +html_theme_options = { + 'light_logo': 'CIS_Controls.jpg', + "light_css_variables": { + "font-stack": "acumin-pro, sans-serif", + "font-stack--monospace": "Courier, monospace", + }, +} + +html_css_files = [ + 'https://use.typekit.net/rcq0ndn.css', +] + +html_favicon = '_static/favicon.ico' + +# -- Options for MyST -------------------------------------------------------- +# https://myst-parser.readthedocs.io/en/stable/configuration.html + +#latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +# 'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +# 'pointsize': '11pt', + +# Additional stuff for the LaTeX preamble. +# 'preamble': r''' +# \usepackage{charter} +# \usepackage[defaultsans]{lato} +# \usepackage{inconsolata} +# ''', +#} + +myst_enable_extensions = [ + 'colon_fence', +] + +myst_heading_anchors = 5 + + From 538cb85d2ae8cffd922ca26fb9c4568888c350e0 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Thu, 7 Dec 2023 16:44:07 -0500 Subject: [PATCH 30/32] Update requirements.txt --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 71c2314..475c6c9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,6 @@ #requirments.txt sphinx==2.4.1 +Jinja2==2.11.3 #sphinx_last_update_by_git From 2346fc14848f3fd86b84cc425bba804bbc8ecd20 Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Fri, 8 Dec 2023 13:48:04 -0500 Subject: [PATCH 31/32] Update .readthedocs.yml --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index bff923c..a87c7e5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -8,7 +8,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.12" + python: "2.7" # You can also specify other tool versions: # nodejs: "20" # rust: "1.70" From 1f47a58fa55a797555a6939a787ee1a39dc318dc Mon Sep 17 00:00:00 2001 From: pswens <134083635+pswens@users.noreply.github.com> Date: Fri, 8 Dec 2023 13:49:08 -0500 Subject: [PATCH 32/32] Update requirements.txt --- docs/requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 475c6c9..6fcf21a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,6 @@ #requirments.txt -sphinx==2.4.1 -Jinja2==2.11.3 +#sphinx==2.4.1 +#Jinja2==2.11.3 #sphinx_last_update_by_git