update documentation

gnu-octave · Mar 27, 2023 · efa2d97 · efa2d97
1 parent 69309c2
commit efa2d97
Show file tree

Hide file tree

Showing 2 changed files with 100 additions and 1 deletion.
diff --git a/docs/index.html b/docs/index.html
@@ -61,7 +61,7 @@
             </div>
             <div class="col-sm-9 col-md-10">
               <h3 class="d-inline-block mr-2">pkg-octave-doc</h3>
-              <b>0.4.7&nbsp;2023-02-26</b>
+              <b>0.4.8&nbsp;2023-03-27</b>
               <p class="indent">
                 This package provides functions for generating HTML pages that  contain the help texts of the functions of an octave package. The package is  designed to work with installed packages and use their INDEX file for creating  the respective functions' HTML pages. The default layout is based on boootstrap  5 and it follows the design of the Octave Packages GitHub page.
               </p>
@@ -113,6 +113,14 @@ <h3 class="category">
                  </td>
                  <td>Generate HTML page for a particular function.</td>
                </tr>
+               <tr>
+                 <td>
+                   <b><code>
+                   <a href="list_packages.html">list_packages</a>
+                   </code></b>
+                 </td>
+                 <td>List installable packages from Octave Packages.</td>
+               </tr>
                <tr>
                  <td>
                    <b><code>

diff --git a/docs/list_packages.html b/docs/list_packages.html
@@ -0,0 +1,91 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title>Octave Package Documentation: list_packages</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css" integrity="sha512-1ycn6IcaQQ40/MKBW2W4Rhis/DbILU74C1vSrLJxCq57o941Ym01SwNsOMqvEBFlcgUa6xLiPY/NS5R+E6ztJQ==" crossorigin="anonymous" referrerpolicy="no-referrer">
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" integrity="sha384-KyZXEAg3QhqLMpG8r+8fhAXLRk2vvoC2f3B09zVXn8CA5QIVfZOJ3BCsw2P0p/We" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-U1DAWAznBHeqEIlVSCgzq+c9gqGAJn5c/t99JyeKa9xxaYpSvHU5awsuZVVFIhvj" crossorigin="anonymous"></script>
+    <script type="text/javascript" async
+      src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_CHTML">
+    </script>
+    <style>
+    var {
+      font-style: italics;
+      font-weight: bold;
+    }
+    td {
+      vertical-align: top;
+    }
+    </style>
+  </head>
+  <body>
+    <div class="bg-dark">
+      <div class="container-xl">
+        <nav class="navbar navbar-expand-lg navbar-dark bg-dark">
+          <div class="container-fluid">
+            <a class="navbar-brand" href=index.html>
+              <img src="assets/pkg-octave-doc.png" alt="pkg-octave-doc" class="d-inline-block align-top" width="25" height="25">
+              Octave Package Documentation
+            </a>
+            <button type="button" class="navbar-toggler" data-bs-toggle="collapse" data-bs-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
+              <span class="navbar-toggler-icon"></span>
+            </button>
+            <div class="collapse navbar-collapse" id="navbarNav">
+              <ul class="navbar-nav">
+                <li class="nav-item">
+                  <a class="nav-link" href="index.html#Documentation">
+                    <i class="fas fa-list-alt"></i>
+                    Documentation
+                  </a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="https://gnu-octave.github.io/packages/">
+                  <img src="assets/octave-logo.svg" alt="GNU Octave logo" class="d-inline-block align-top" width="25" height="25">
+                    Octave Packages
+                  </a>
+                </li>
+                <li class="nav-item">
+                  <a class="nav-link" href="https://www.octave.org">
+                    <i class="fas fa-home"></i>
+                    GNU Octave website
+                  </a>
+                </li>
+              </ul>
+            </div>
+          </div>
+        </nav>
+      </div>
+    </div>
+    <div class="container-xl my-4">
+      <div class="card rounded">
+        <div class="card-header card-header-mod">
+          <div class="row d-flex flex-wrap align-items-center">
+            <div class="col-sm-3 col-md-5 mb-2 mb-sm-0">
+              <h3 class="d-inline-block mr-2">
+              Function&nbsp;Reference: <b><code>list_packages</code></b>
+              </h3>
+            </div>
+          </div>
+        </div>
+        <div class="card-body">
+<dl>
+<dt><u>pkg-octave-doc:</u> <var>valid_packages</var> = <b>list_packages</b><i> ()</i></dt>
+</dl>
+
+<p> List installable packages from Octave Packages.
+</p>
+<div class="ms-5">
+
+<p><strong>Source Code: </strong>
+  <a href="https://github.com/gnu-octave/pkg-octave-doc/tree/main/inst/list_packages.m">list_packages</a>
+</div>
+
+
+        </div>
+      </div>
+    </div>
+
+  </body>
+</html>