Deploying to gh-pages from @ ffc86fe 🚀

_sources/index.rst.txt

@@ -1,7 +1,7 @@
 Welcome to certy's documentation!
 =================================
 
-Certy provides a simple API for creating X509 certificates on demand when running unit tests.
+Certy provides a simple API for creating X509 certificates and certificate revocation lists on demand when running unit tests.
 No more storing test certificates and private keys in the repository!
 
 Python-certy is a version of similar tool for command line and Golang called `certyaml`_ and `java-certy`_ for Java.

_static/basic.css

@@ -237,6 +237,10 @@ a.headerlink {
     visibility: hidden;
 }
 
+a:visited {
+    color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
     margin-left: 30px;
 }
 
+.sig dd {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
+.sig dl {
+    margin-top: 0px;
+    margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
     margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
     cursor: help;
 }
 
+.translated {
+    background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+    background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

_static/documentation_options.js

@@ -1,5 +1,4 @@
-var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+const DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,

_static/pygments.css

@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #E40000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #008400 } /* Generic.Inserted */

_static/searchtools.js

@@ -57,12 +57,12 @@ const _removeChildren = (element) => {
 const _escapeRegExp = (string) =>
   string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
 
-const _displayItem = (item, searchTerms) => {
+const _displayItem = (item, searchTerms, highlightTerms) => {
   const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
-  const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT;
   const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
   const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
   const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
+  const contentRoot = document.documentElement.dataset.content_root;
 
   const [docName, title, anchor, descr, score, _filename] = item;
 
@@ -75,20 +75,24 @@ const _displayItem = (item, searchTerms) => {
     if (dirname.match(/\/index\/$/))
       dirname = dirname.substring(0, dirname.length - 6);
     else if (dirname === "index/") dirname = "";
-    requestUrl = docUrlRoot + dirname;
+    requestUrl = contentRoot + dirname;
     linkUrl = requestUrl;
   } else {
     // normal html builders
-    requestUrl = docUrlRoot + docName + docFileSuffix;
+    requestUrl = contentRoot + docName + docFileSuffix;
     linkUrl = docName + docLinkSuffix;
   }
   let linkEl = listItem.appendChild(document.createElement("a"));
   linkEl.href = linkUrl + anchor;
   linkEl.dataset.score = score;
   linkEl.innerHTML = title;
-  if (descr)
+  if (descr) {
     listItem.appendChild(document.createElement("span")).innerHTML =
       " (" + descr + ")";
+    // highlight search terms in the description
+    if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+      highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
+  }
   else if (showSearchSummary)
     fetch(requestUrl)
       .then((responseData) => responseData.text())
@@ -97,6 +101,9 @@ const _displayItem = (item, searchTerms) => {
           listItem.appendChild(
             Search.makeSearchSummary(data, searchTerms)
           );
+        // highlight search terms in the summary
+        if (SPHINX_HIGHLIGHT_ENABLED)  // set in sphinx_highlight.js
+          highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
       });
   Search.output.appendChild(listItem);
 };
@@ -115,14 +122,15 @@ const _finishSearch = (resultCount) => {
 const _displayNextItem = (
   results,
   resultCount,
-  searchTerms
+  searchTerms,
+  highlightTerms,
 ) => {
   // results left, load the summary and display it
   // this is intended to be dynamic (don't sub resultsCount)
   if (results.length) {
-    _displayItem(results.pop(), searchTerms);
+    _displayItem(results.pop(), searchTerms, highlightTerms);
     setTimeout(
-      () => _displayNextItem(results, resultCount, searchTerms),
+      () => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
       5
     );
   }
@@ -360,7 +368,7 @@ const Search = {
     // console.info("search results:", Search.lastresults);
 
     // print the results
-    _displayNextItem(results, results.length, searchTerms);
+    _displayNextItem(results, results.length, searchTerms, highlightTerms);
   },
 
   /**

_static/sphinx_highlight.js

@@ -29,14 +29,19 @@ const _highlight = (node, addItems, text, className) => {
       }
 
       span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+      const rest = document.createTextNode(val.substr(pos + text.length));
       parent.insertBefore(
         span,
         parent.insertBefore(
-          document.createTextNode(val.substr(pos + text.length)),
+          rest,
           node.nextSibling
         )
       );
       node.nodeValue = val.substr(0, pos);
+      /* There may be more occurrences of search term in this node. So call this
+       * function recursively on the remaining fragment.
+       */
+      _highlight(rest, addItems, text, className);
 
       if (isInSVG) {
         const rect = document.createElementNS(
@@ -140,5 +145,10 @@ const SphinxHighlight = {
   },
 };
 
-_ready(SphinxHighlight.highlightSearchWords);
-_ready(SphinxHighlight.initEscapeListener);
+_ready(() => {
+  /* Do not call highlightSearchWords() when we are on the search page.
+   * It will highlight words from the *previous* search query.
+   */
+  if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
+  SphinxHighlight.initEscapeListener();
+});

genindex.html

@@ -10,11 +10,11 @@
     <script src="_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script src="_static/jquery.js"></script>
-        <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
-        <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
-        <script src="_static/doctools.js"></script>
-        <script src="_static/sphinx_highlight.js"></script>
+        <script src="_static/jquery.js?v=5d32c60e"></script>
+        <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="_static/doctools.js?v=888ff710"></script>
+        <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" /> 
@@ -68,7 +68,8 @@
 <h1 id="index">Index</h1>
 
 <div class="genindex-jumpbox">
- <a href="#C"><strong>C</strong></a>
+ <a href="#A"><strong>A</strong></a>
+ | <a href="#C"><strong>C</strong></a>
  | <a href="#D"><strong>D</strong></a>
  | <a href="#E"><strong>E</strong></a>
  | <a href="#G"><strong>G</strong></a>
@@ -83,10 +84,20 @@ <h1 id="index">Index</h1>
  | <a href="#W"><strong>W</strong></a>
 
 </div>
+<h2 id="A">A</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#certy.CertificateRevocationList.add">add() (certy.CertificateRevocationList method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#certy.Credential.ca">ca() (certy.Credential method)</a>
+</li>
+      <li><a href="index.html#certy.CertificateRevocationList">CertificateRevocationList (class in certy)</a>
 </li>
       <li>
     certy
@@ -102,6 +113,8 @@ <h2 id="C">C</h2>
       <li><a href="index.html#certy.ExtendedKeyUsage.CODE_SIGNING">CODE_SIGNING (certy.ExtendedKeyUsage attribute)</a>
 </li>
       <li><a href="index.html#certy.Credential">Credential (class in certy)</a>
+</li>
+      <li><a href="index.html#certy.Credential.crl_distribution_point_uri">crl_distribution_point_uri() (certy.Credential method)</a>
 </li>
       <li><a href="index.html#certy.KeyUsage.CRL_SIGN">CRL_SIGN (certy.KeyUsage attribute)</a>
 </li>
@@ -145,14 +158,22 @@ <h2 id="E">E</h2>
 <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#certy.Credential.generate">generate() (certy.Credential method)</a>
+      <li><a href="index.html#certy.CertificateRevocationList.generate">generate() (certy.CertificateRevocationList method)</a>
+
+      <ul>
+        <li><a href="index.html#certy.Credential.generate">(certy.Credential method)</a>
 </li>
-      <li><a href="index.html#certy.Credential.get_certificate">get_certificate() (certy.Credential method)</a>
+      </ul></li>
+      <li><a href="index.html#certy.CertificateRevocationList.get_as_der">get_as_der() (certy.CertificateRevocationList method)</a>
 </li>
-      <li><a href="index.html#certy.Credential.get_certificate_as_pem">get_certificate_as_pem() (certy.Credential method)</a>
+      <li><a href="index.html#certy.CertificateRevocationList.get_as_pem">get_as_pem() (certy.CertificateRevocationList method)</a>
+</li>
+      <li><a href="index.html#certy.Credential.get_certificate">get_certificate() (certy.Credential method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#certy.Credential.get_certificate_as_pem">get_certificate_as_pem() (certy.Credential method)</a>
+</li>
       <li><a href="index.html#certy.Credential.get_certificates">get_certificates() (certy.Credential method)</a>
 </li>
       <li><a href="index.html#certy.Credential.get_certificates_as_pem">get_certificates_as_pem() (certy.Credential method)</a>
@@ -167,8 +188,12 @@ <h2 id="G">G</h2>
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#certy.Credential.issuer">issuer() (certy.Credential method)</a>
+      <li><a href="index.html#certy.CertificateRevocationList.issuer">issuer() (certy.CertificateRevocationList method)</a>
+
+      <ul>
+        <li><a href="index.html#certy.Credential.issuer">(certy.Credential method)</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
@@ -212,6 +237,8 @@ <h2 id="M">M</h2>
 <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#certy.CertificateRevocationList.next_update">next_update() (certy.CertificateRevocationList method)</a>
+</li>
       <li><a href="index.html#certy.KeyUsage.NON_REPUDIATION">NON_REPUDIATION (certy.KeyUsage attribute)</a>
 </li>
   </ul></td>
@@ -257,6 +284,10 @@ <h2 id="S">S</h2>
 
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#certy.CertificateRevocationList.this_update">this_update() (certy.CertificateRevocationList method)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#certy.ExtendedKeyUsage.TIME_STAMPING">TIME_STAMPING (certy.ExtendedKeyUsage attribute)</a>
 </li>
@@ -267,10 +298,14 @@ <h2 id="W">W</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#certy.Credential.write_certificate_as_pem">write_certificate_as_pem() (certy.Credential method)</a>
+</li>
+      <li><a href="index.html#certy.Credential.write_certificates_as_pem">write_certificates_as_pem() (certy.Credential method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#certy.Credential.write_certificates_as_pem">write_certificates_as_pem() (certy.Credential method)</a>
+      <li><a href="index.html#certy.CertificateRevocationList.write_der">write_der() (certy.CertificateRevocationList method)</a>
+</li>
+      <li><a href="index.html#certy.CertificateRevocationList.write_pem">write_pem() (certy.CertificateRevocationList method)</a>
 </li>
       <li><a href="index.html#certy.Credential.write_private_key_as_pem">write_private_key_as_pem() (certy.Credential method)</a>
 </li>