Skip to content

Commit

Permalink
[doc] expand online doco links in readme, add GH repo link to online …
Browse files Browse the repository at this point in the history
…doco front page
  • Loading branch information
apjanke committed Jan 29, 2024
1 parent a7c2492 commit f53e609
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,16 @@ If you want to hack on the Tablicious code itself, set it up like this:

* Clone the repo
* `git clone https://github.com/apjanke/octave-tablicious`
* Add the `inst/` directory from the repo to your Octave path.
* Add the `inst/` directory from the cloned repo to your Octave path with `addpath`.

That should get everything working except for time zone conversions inside `datetime`, which require a compiled oct-file. See the developer doco in the repo for that.

## Documentation

Once you have Tablicious installed, the user manual will show up in the Octave GUI’s documentation browser.
You can also run `help <foo>` or `doc <foo>` for any of the classes or functions in Tablicious.

The documentation for the latest development version can be viewed online at <https://apjanke.github.io/octave-tablicious/user-guide/tablicious.html>.
The documentation for the latest development version can be viewed online at <https://tablicious.janklab.net>. That site has the [Tablicious User Guide](https://tablicious.janklab.net/user-guide/html/index.html) containing the API reference (also available in [single-page form](https://tablicious.janklab.net/user-guide/tablicious.html)), plus some additional developer-oriented documentation.

See the `docs/` directory for notes on this project, especially for [Developer Notes](docs/Developer-Notes.md) and [Design and Justification](docs/Design-and-Justification.md), which discusses how and why this library is written. Also see [CONTRIBUTING](CONTRIBUTING.md) if you would like to contribute to this project.

Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This is the documentation site for Tablicious.

Tablicious is a package for GNU Octave that provides relational data structures for Octave. It includes implementations of `table` arrays, `datetime`, `string`, `categorical`, and some other related stuff. You can think of it as "pandas for Octave".

The repo for this project is at <https://github.com/apjanke/octave-tablicious>, where you can get the source code, report issues, and find more information.

## User Documentation

See the online [User Guide](user-guide/html/index.html) for info and API Reference. There's also a [single-page version of the User Guide](user-guide/tablicious.html).
Expand Down

0 comments on commit f53e609

Please sign in to comment.