Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update for next release
  • Loading branch information
pr0m1th3as authored Jan 21, 2024
1 parent 00a5897 commit 2b22699
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@

# pkg-octave-doc

Create a **function reference** from Octave help texts (docstrings)
from single functions or all functions in a package, which can be installed
Create online documentation from Octave help texts (docstrings)
of functions and classes in a package, which can be installed
with **pkg**. The generated pages follow the template of the Octave Packages at
GitHub Pages based on bootstrap 5 and they have similar layout to the older
documentation reference pages at Source Forge.
documentation reference pages at Source Forge. The documentation also includes
the demos that are available. Legacy classes (in `@class/` folders) are processed
as individual functions with separate html pages, `classdef` files are processed
collectively including their public methods in a single html page.

You can find its documentation at [https://gnu-octave.github.io/pkg-octave-doc/](https://gnu-octave.github.io/pkg-octave-doc/).

Expand All @@ -24,7 +27,7 @@ feature is only available for packages hosted at GitHub.

## Installation

To install the latest version (0.5.1) you need Octave (>=7.2.0) installed on your system. You can install it by typing:
To install the latest version (0.5.2) you need Octave (>=7.2.0) installed on your system. You can install it by typing:

```
pkg install -forge pkg-octave-doc
Expand Down

0 comments on commit 2b22699

Please sign in to comment.