Doc: add doc for ccnp

* Add sphinx based html documentation * revise github pylint workflow to exclude docs/ folder from inspection Signed-off-by: Ruoyu Ying <[email protected]>
intel · Jan 10, 2024 · 68deeec · 68deeec
1 parent 11bf8b6
commit 68deeec
Show file tree

Hide file tree

Showing 106 changed files with 9,399 additions and 0 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: fc7a2c9964d336543b9179413d12d010
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/ccnp.doctree b/docs/.doctrees/ccnp.doctree
diff --git a/docs/.doctrees/ccnp.eventlog.doctree b/docs/.doctrees/ccnp.eventlog.doctree
diff --git a/docs/.doctrees/ccnp.measurement.doctree b/docs/.doctrees/ccnp.measurement.doctree
diff --git a/docs/.doctrees/ccnp.quote.doctree b/docs/.doctrees/ccnp.quote.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/eventlog/eventlog.doctree b/docs/.doctrees/eventlog/eventlog.doctree
diff --git a/docs/.doctrees/eventlog/modules.doctree b/docs/.doctrees/eventlog/modules.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/measurement/measurement.doctree b/docs/.doctrees/measurement/measurement.doctree
diff --git a/docs/.doctrees/measurement/modules.doctree b/docs/.doctrees/measurement/modules.doctree
diff --git a/docs/.doctrees/modules.doctree b/docs/.doctrees/modules.doctree
diff --git a/docs/.doctrees/quote/modules.doctree b/docs/.doctrees/quote/modules.doctree
diff --git a/docs/.doctrees/quote/quote.doctree b/docs/.doctrees/quote/quote.doctree
diff --git a/docs/.doctrees/readme.doctree b/docs/.doctrees/readme.doctree
diff --git a/docs/.doctrees/source/ccnp.doctree b/docs/.doctrees/source/ccnp.doctree
diff --git a/docs/.doctrees/source/ccnp.eventlog.doctree b/docs/.doctrees/source/ccnp.eventlog.doctree
diff --git a/docs/.doctrees/source/ccnp.measurement.doctree b/docs/.doctrees/source/ccnp.measurement.doctree
diff --git a/docs/.doctrees/source/ccnp.quote.doctree b/docs/.doctrees/source/ccnp.quote.doctree
diff --git a/docs/.doctrees/source/modules.doctree b/docs/.doctrees/source/modules.doctree
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/_rst/ccnp.eventlog.html b/docs/_rst/ccnp.eventlog.html
diff --git a/docs/_rst/ccnp.html b/docs/_rst/ccnp.html
@@ -0,0 +1,104 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" >
+<head>
+  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>ccnp package &mdash; Confidential Cloud-Native Primitives  documentation</title>
+      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=b3ba4146"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            Confidential Cloud-Native Primitives
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">CCNP Modules</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">Confidential Cloud-Native Primitives</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">ccnp package</li>
+      <li class="wy-breadcrumbs-aside">
+            <a href="../_sources/_rst/ccnp.rst.txt" rel="nofollow"> View page source</a>
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <section id="ccnp-package">
+<h1>ccnp package<a class="headerlink" href="#ccnp-package" title="Permalink to this heading">¶</a></h1>
+<div class="toctree-wrapper compound">
+</div>
+</section>
+
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2023, Intel.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>