docs: Initial documentation template ready for readthedocs.

This is based on Arm's OoB Solutions Documentation Template.

The simple parts are filled in, but the bulk of the documentation will
be committed separately.

Signed-off-by: Ryan Roberts <ryan.roberts@arm.com>

14 files changed, 330 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index 90e7dee..e382c92 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
 __pycache__/
 shrinkwrap/build/
 shrinkwrap/package/
+documentation/_build/
+public/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..db03613
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,12 @@
+# .readthedocs.yaml
+# ReadTheDocs configuration file.
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details.
+
+version: 2
+sphinx:
+  configuration: documentation/conf.py
+formats:
+  - pdf
+python:
+  install:
+  - requirements: documentation/requirements.txt
diff --git a/documentation/_static/css/custom.css b/documentation/_static/css/custom.css
new file mode 100644
index 0000000..dceac1b
--- /dev/null
+++ b/documentation/_static/css/custom.css
@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2022, Arm Limited.
+ *
+ *  SPDX-License-Identifier: MIT
+*/
+
+.wy-nav-content {
+    max-width: 75% !important;
+}
+
+/* override table no-wrap */
+.wy-table-responsive table td, .wy-table-responsive table th {
+    white-space: normal;
+}
\ No newline at end of file
diff --git a/documentation/conf.py b/documentation/conf.py
new file mode 100644
index 0000000..5c57195
--- /dev/null
+++ b/documentation/conf.py
@@ -0,0 +1,99 @@
+# Copyright (c) 2022, Arm Limited.
+#
+# SPDX-License-Identifier: MIT
+
+
+# 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
+
+# -- 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 os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Shrinkwrap'
+copyright = '2022, Arm Limited'
+author = 'Arm Limited'
+
+
+# -- General configuration ---------------------------------------------------
+
+#import sphinx_rtd_theme
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autosectionlabel',
+    'sphinx_rtd_theme',
+    'sphinx_copybutton',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+html_css_files = [
+    'css/custom.css',
+]
+
+# Don't show the "Built with Sphinx" footer
+html_show_sphinx = False
+
+html_theme_options = {
+    'collapse_navigation': False,
+    'navigation_depth': 5,
+    'prev_next_buttons_location': "both"
+}
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for autosectionlabel --------------------------------------------
+
+# Prefix each section label with the name of the document it is in
+autosectionlabel_prefix_document = True
+# Only generate automatic section labels for document titles
+autosectionlabel_maxdepth = 1
+
+# -- Options for copybutton --------------------------------------------------
+copybutton_prompt_text = r'\$ '
+copybutton_prompt_is_regexp = True
+copybutton_remove_prompts = True
+copybutton_only_copy_prompt_lines = True
+copybutton_copy_empty_lines = False
+copybutton_line_continuation_character = "\\"
diff --git a/documentation/index.rst b/documentation/index.rst
new file mode 100644
index 0000000..a7b8615
--- /dev/null
+++ b/documentation/index.rst
@@ -0,0 +1,19 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+##########
+Shrinkwrap
+##########
+
+********
+Contents
+********
+
+.. toctree::
+   :maxdepth: 3
+
+   overview
+   user_guide/index
+   license_file_link
diff --git a/documentation/license_file_link.rst b/documentation/license_file_link.rst
new file mode 100644
index 0000000..78bada2
--- /dev/null
+++ b/documentation/license_file_link.rst
@@ -0,0 +1,6 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+.. include:: ../license.rst
diff --git a/documentation/overview.rst b/documentation/overview.rst
new file mode 100644
index 0000000..65fc15c
--- /dev/null
+++ b/documentation/overview.rst
@@ -0,0 +1,80 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+########
+Overview
+########
+
+************
+Introduction
+************
+
+Here we expect a brief introduction about the solution as well as the main
+target audience and use cases.
+
+*********************
+Solution Architecture
+*********************
+
+A high-level diagram included with some explanation highlighting the main
+features and deliverables.
+
+********
+Features
+********
+
+- **Feature A:**
+- **Feature B:**
+
+*********
+Use Cases
+*********
+
+- **Use Case A:**
+- **Use Case B:**
+
+********************
+Repository Structure
+********************
+
+=================== ====
+Directory           Description
+=================== ====
+./docker            Scripts to generate docker images used by shrinkwrap's
+                    container runtimes.
+./documentation     Source for this documentation.
+./shrinkwrap        Shrinkwrap Python tool implementation.
+./shrinkwrap/config Shrinkwrap standard config store.
+=================== ====
+
+******************
+Repository License
+******************
+
+The software is provided under an MIT license (more details in
+:ref:`license_file_link:License`).
+
+Contributions to the project should follow the same license.
+
+*****************************
+Contributions and Bug Reports
+*****************************
+
+This project has not put in place a process for contributions currently.
+
+For bug reports, please contact Ryan Roberts <ryan.roberts@arm.com>.
+
+********************
+Feedback and support
+********************
+
+To request support please contact Arm at support@arm.com. Arm licensees may also
+contact Arm via their partner managers.
+
+*************
+Maintainer(s)
+*************
+
+- Ryan Roberts <ryan.roberts@arm.com>
diff --git a/documentation/requirements.txt b/documentation/requirements.txt
new file mode 100644
index 0000000..b82e5e0
--- /dev/null
+++ b/documentation/requirements.txt
@@ -0,0 +1,12 @@
+# Copyright (c) 2022, Arm Limited.
+#
+# SPDX-License-Identifier: MIT
+
+# Read The Docs specific
+jinja2==3.1.1
+
+# Required to build the documentation
+sphinx==4.5.0
+sphinx_rtd_theme==1.0.0
+sphinx-copybutton==0.5.0
+docutils==0.17.1
diff --git a/documentation/user_guide/commands.rst b/documentation/user_guide/commands.rst
new file mode 100644
index 0000000..a2db52e
--- /dev/null
+++ b/documentation/user_guide/commands.rst
@@ -0,0 +1,8 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+########
+Commands
+########
diff --git a/documentation/user_guide/config.rst b/documentation/user_guide/config.rst
new file mode 100644
index 0000000..5cdabf1
--- /dev/null
+++ b/documentation/user_guide/config.rst
@@ -0,0 +1,8 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+#######
+Configs
+#######
diff --git a/documentation/user_guide/index.rst b/documentation/user_guide/index.rst
new file mode 100644
index 0000000..c94ca6e
--- /dev/null
+++ b/documentation/user_guide/index.rst
@@ -0,0 +1,18 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+##########
+User Guide
+##########
+
+.. toctree::
+   :titlesonly:
+   :maxdepth: 2
+   :caption: Contents
+
+   quickstart
+   runtimes
+   commands
+   config
diff --git a/documentation/user_guide/quickstart.rst b/documentation/user_guide/quickstart.rst
new file mode 100644
index 0000000..87d23da
--- /dev/null
+++ b/documentation/user_guide/quickstart.rst
@@ -0,0 +1,3 @@
+#################
+Quick Start Guide
+#################
diff --git a/documentation/user_guide/runtimes.rst b/documentation/user_guide/runtimes.rst
new file mode 100644
index 0000000..12ab431
--- /dev/null
+++ b/documentation/user_guide/runtimes.rst
@@ -0,0 +1,8 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+#########
+Run-Times
+#########
diff --git a/license.rst b/license.rst
new file mode 100644
index 0000000..ec6efc0
--- /dev/null
+++ b/license.rst
@@ -0,0 +1,41 @@
+#######
+License
+#######
+
+The software is provided under the MIT license (below).
+
+.. code-block:: none
+
+    Copyright (c) 2022 Arm Limited
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to
+    deal in the Software without restriction, including without limitation the
+    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    sell copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice (including the next
+    paragraph) shall be included in all copies or substantial portions of the
+    Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+    IN THE SOFTWARE.
+
+****************
+SPDX Identifiers
+****************
+
+Individual files contain the following tag instead of the full license text.
+
+.. code-block:: none
+
+    SPDX-License-Identifier: MIT
+
+This enables machine processing of license information based on the SPDX
+License Identifiers that are here available: http://spdx.org/licenses/