Skip to content

Commit

Permalink
update HTML documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pr0m1th3as committed Feb 26, 2023
1 parent 9b4ff08 commit 407200e
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 3 deletions.
3 changes: 3 additions & 0 deletions docs/build_DEMOS.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down
3 changes: 3 additions & 0 deletions docs/find_DEMOS.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down
3 changes: 3 additions & 0 deletions docs/find_GHurls.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down
7 changes: 5 additions & 2 deletions docs/function_texi2html.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down Expand Up @@ -79,7 +82,7 @@ <h3 class="d-inline-block mr-2">
available functions of a package; and <var>info</var>, a structure with relevant
information about the package, which the function <var>fcnname</var> belongs to.
</p>
<p> <var>pkgfcns</var> can be either a <em>Nx2</em> or a <em>Nx3</em> cell array, whose
<p> <var>pkgfcns</var> can be either a <math>N&times;2</math> or a <math>N&times;3</math> cell array, whose
1st column list all available function names, the 2nd column list the each
function&rsquo;s category, and the 3rd column contains the URL to the function&rsquo;s
source code. <var>pkgfcns</var> is used to relative references to other pages of
Expand All @@ -101,7 +104,7 @@ <h3 class="d-inline-block mr-2">
located inside the <code>assets/</code> folder.</td></tr>
</table>

<p> To generate a suitable <em>Nx2</em> cell array for a specific package, use the
<p> To generate a suitable <math>N&times;2</math> cell array for a specific package, use the
<code>package_texi2html</code> function and to populate is with the 3rd column use
<code>find_GHurls</code>. The <var>info</var> structure can also be created with
<code>package_texi2html</code>.
Expand Down
5 changes: 4 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down Expand Up @@ -58,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.5&nbsp;2023-02-20</b>
<b>0.4.7&nbsp;2023-02-26</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>
Expand Down
3 changes: 3 additions & 0 deletions docs/package_texi2html.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
font-style: italics;
font-weight: bold;
}
td {
vertical-align: top;
}
</style>
</head>
<body>
Expand Down

0 comments on commit 407200e

Please sign in to comment.