diff --git a/.gitignore b/.gitignore index ae6f328..10726cc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ - docs/ _build/ conf.py _tmp/ + diff --git a/.readthedocs.yml b/.readthedocs.yml index fdab351..a87c7e5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,11 +1,35 @@ -# Reference: https://docs.readthedocs.io/en/latest/yaml-config.html +# 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: - image: latest + os: ubuntu-22.04 + tools: + python: "2.7" + # 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 -# 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 +# Optionally build your docs in additional formats such as PDF and ePub # formats: # - pdf +# - epub + +# 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 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..cb71169 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,92 @@ +# 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 + + diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..6fcf21a --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,6 @@ +#requirments.txt + +#sphinx==2.4.1 +#Jinja2==2.11.3 + +#sphinx_last_update_by_git